3.0.24

changelog.md

@@ -0,0 +1,79 @@
+# Changelog
+
+## 2024-11-18 - 3.0.24 - fix(metadata)
+Fix metadata handling to address type assertion and data retrieval.
+
+- Fixed type assertion issues in `MetaData` class properties with type non-null assertions.
+- Corrected the handling of JSON data retrieval in `MetaData.storeCustomMetaData` function.
+
+## 2024-10-16 - 3.0.23 - fix(dependencies)
+Update package dependencies for improved functionality and security.
+
+- Updated @aws-sdk/client-s3 to version ^3.670.0 for enhanced S3 client capabilities.
+- Updated @push.rocks/smartstream to version ^3.2.4.
+- Updated the dev dependency @push.rocks/tapbundle to version ^5.3.0.
+
+## 2024-07-28 - 3.0.22 - fix(dependencies)
+Update dependencies and improve bucket retrieval logging
+
+- Updated @aws-sdk/client-s3 to ^3.620.0
+- Updated @git.zone/tsbuild to ^2.1.84
+- Updated @git.zone/tsrun to ^1.2.49
+- Updated @push.rocks/smartpromise to ^4.0.4
+- Updated @tsclass/tsclass to ^4.1.2
+- Added a log for when a bucket is not found by name in getBucketByName method
+
+## 2024-07-04 - 3.0.21 - fix(test)
+Update endpoint configuration in tests to use environment variable
+
+- Modified `qenv.yml` to include `S3_ENDPOINT` as a required environment variable.
+- Updated test files to fetch `S3_ENDPOINT` from environment instead of hardcoding.
+
+## 2024-06-19 - 3.0.20 - Fix and Stability Updates
+Improved overall stability and consistency.
+
+## 2024-06-18 - 3.0.18 - Delete Functions Consistency
+Ensured more consistency between delete methods and trash behavior.
+
+## 2024-06-17 - 3.0.17 to 3.0.16 - Fix and Update
+Routine updates and fixes performed.
+
+## 2024-06-11 - 3.0.15 to 3.0.14 - Fix and Update
+Routine updates and fixes performed.
+
+## 2024-06-10 - 3.0.13 - Trash Feature Completion
+Finished work on trash feature.
+
+## 2024-06-09 - 3.0.12 - Fix and Update
+Routine updates and fixes performed.
+
+## 2024-06-08 - 3.0.11 to 3.0.10 - Fix and Update
+Routine updates and fixes performed.
+
+## 2024-06-03 - 3.0.10 - Fix and Update
+Routine updates and fixes performed.
+
+## 2024-05-29 - 3.0.9 - Update Description
+Updated project description.
+
+## 2024-05-27 - 3.0.8 to 3.0.6 - Pathing and Core Updates
+Routine updates and fixes performed.
+  - S3 paths' pathing differences now correctly handled with a reducePath method.
+
+## 2024-05-21 - 3.0.5 to 3.0.4 - Fix and Update
+Routine updates and fixes performed.
+
+## 2024-05-17 - 3.0.3 to 3.0.2 - Fix and Update
+Routine updates and fixes performed.
+
+## 2024-05-17 - 3.0.0 - Major Release
+Introduced breaking changes in core and significant improvements.
+
+## 2024-05-05 - 2.0.5 - Breaking Changes
+Introduced breaking changes in core functionality.
+
+## 2024-04-14 - 2.0.4 - TSConfig Update
+Updated TypeScript configuration.
+
+## 2024-01-01 - 2.0.2 - Organization Scheme Update
+Switched to the new organizational scheme.

package-lock.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/smartbucket",
-  "version": "3.0.12",
+  "version": "3.0.24",
   "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",
@@ -12,21 +12,22 @@
     "build": "(tsbuild --web --allowimplicitany)"
   },
   "devDependencies": {
-    "@git.zone/tsbuild": "^2.1.80",
+    "@git.zone/tsbuild": "^2.1.84",
-    "@git.zone/tsrun": "^1.2.46",
+    "@git.zone/tsrun": "^1.2.49",
     "@git.zone/tstest": "^1.0.90",
     "@push.rocks/qenv": "^6.0.5",
-    "@push.rocks/tapbundle": "^5.0.23"
+    "@push.rocks/tapbundle": "^5.3.0"
   },
   "dependencies": {
+    "@aws-sdk/client-s3": "^3.670.0",
     "@push.rocks/smartmime": "^2.0.2",
     "@push.rocks/smartpath": "^5.0.18",
-    "@push.rocks/smartpromise": "^4.0.3",
+    "@push.rocks/smartpromise": "^4.0.4",
     "@push.rocks/smartrx": "^3.0.7",
-    "@push.rocks/smartstream": "^3.0.44",
+    "@push.rocks/smartstream": "^3.2.4",
+    "@push.rocks/smartstring": "^4.0.15",
     "@push.rocks/smartunique": "^3.0.9",
-    "@tsclass/tsclass": "^4.0.55",
+    "@tsclass/tsclass": "^4.1.2"
-    "minio": "^8.0.0"
   },
   "private": false,
   "files": [

qenv.yml

@@ -1,3 +1,4 @@
 required:
   - S3_KEY
-  - S3_SECRET
+  - S3_SECRET
+  - S3_ENDPOINT

test/test.trash.ts

@@ -0,0 +1,28 @@
+import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
+import { Qenv } from '@push.rocks/qenv';
+
+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: await testQenv.getEnvVarOnDemand('S3_KEY'),
+    accessSecret: await testQenv.getEnvVarOnDemand('S3_SECRET'),
+    endpoint: await testQenv.getEnvVarOnDemand('S3_ENDPOINT'),
+  });
+  expect(testSmartbucket).toBeInstanceOf(smartbucket.SmartBucket);
+  myBucket = await testSmartbucket.getBucketByName('testzone');
+  expect(myBucket).toBeInstanceOf(smartbucket.Bucket);
+  expect(myBucket.name).toEqual('testzone');
+});
+
+tap.test('', async () => {
+  
+})
+
+export default tap.start();

test/test.ts

@@ -13,24 +13,22 @@ tap.test('should create a valid smartbucket', async () => {
   testSmartbucket = new smartbucket.SmartBucket({
     accessKey: await testQenv.getEnvVarOnDemand('S3_KEY'),
     accessSecret: await testQenv.getEnvVarOnDemand('S3_SECRET'),
-    endpoint: 's3.eu-central-1.wasabisys.com',
+    endpoint: await testQenv.getEnvVarOnDemand('S3_ENDPOINT'),
   });
-});
+  expect(testSmartbucket).toBeInstanceOf(smartbucket.SmartBucket);
-
-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).toBeInstanceOf(smartbucket.Bucket);
   expect(myBucket.name).toEqual('testzone');
 });
 
+tap.skip.test('should create testbucket', async () => {
+  // await testSmartbucket.createBucket('testzone2');
+});
+
+tap.skip.test('should remove testbucket', async () => {
+  // await testSmartbucket.removeBucket('testzone2');
+});
+
 // Fast operations
 tap.test('should store data in bucket fast', async () => {
   await myBucket.fastPut({

ts/00_commitinfo_data.ts

@@ -1,8 +1,8 @@
 /**
- * autocreated commitinfo by @pushrocks/commitinfo
+ * autocreated commitinfo by @push.rocks/commitinfo
  */
 export const commitinfo = {
   name: '@push.rocks/smartbucket',
-  version: '3.0.12',
+  version: '3.0.24',
   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

@@ -1,33 +1,43 @@
+// classes.bucket.ts
+
 import * as plugins from './plugins.js';
 import * as helpers from './helpers.js';
 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 basic 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();
+    const command = new plugins.s3.ListBucketsCommand({});
-    const foundBucket = buckets.find((bucket) => {
+    const buckets = await smartbucketRef.s3Client.send(command);
-      return bucket.name === bucketNameArg;
+    const foundBucket = buckets.Buckets.find((bucket) => 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 {
+      console.log(`did not find bucket by name: ${bucketNameArg}`);
       return null;
     }
   }
 
   public static async createBucketByName(smartbucketRef: SmartBucket, bucketName: string) {
-    await smartbucketRef.minioClient.makeBucket(bucketName, 'ams3').catch((e) => console.log(e));
+    const command = new plugins.s3.CreateBucketCommand({ Bucket: bucketName });
+    await smartbucketRef.s3Client.send(command).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));
+    const command = new plugins.s3.DeleteBucketCommand({ Bucket: bucketName });
+    await smartbucketRef.s3Client.send(command).catch((e) => console.log(e));
   }
 
   public smartbucketRef: SmartBucket;
@@ -45,11 +55,21 @@ 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();
     }
-    let checkPath = await helpers.reducePathDescriptorToPath(pathDescriptorArg);
+    const checkPath = await helpers.reducePathDescriptorToPath(pathDescriptorArg);
     const baseDirectory = await this.getBaseDirectory();
     return await baseDirectory.getSubDirectoryByName(checkPath);
   }
@@ -61,34 +81,34 @@ export class Bucket {
   /**
    * store file
    */
-  public async fastPut(optionsArg: {
+  public async fastPut(
-    path: string;
+    optionsArg: interfaces.IPathDecriptor & {
-    contents: string | Buffer;
+      contents: string | Buffer;
-    overwrite?: boolean;
+      overwrite?: boolean;
-  }): Promise<File> {
+    }
+  ): Promise<File> {
     try {
-      const reducedPath = await helpers.reducePathDescriptorToPath({
+      const reducedPath = await helpers.reducePathDescriptorToPath(optionsArg);
-        path: optionsArg.path,
-      })
-      // 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 command = new plugins.s3.PutObjectCommand({
-      const streamIntake = new plugins.smartstream.StreamIntake();
+        Bucket: this.name,
-      const putPromise = this.smartbucketRef.minioClient.putObject(this.name, reducedPath, streamIntake);
+        Key: reducedPath,
-      streamIntake.pushData(optionsArg.contents);
+        Body: optionsArg.contents,
-      streamIntake.signalEnd();
+      });
-      await putPromise;
+      await this.smartbucketRef.s3Client.send(command);
-  
+
       console.log(`Object '${reducedPath}' has been successfully stored in bucket '${this.name}'.`);
       const parsedPath = plugins.path.parse(reducedPath);
       return new File({
@@ -98,18 +118,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: {
+  public async fastGet(optionsArg: { path: string }): Promise<Buffer> {
-    path: string
-  }): Promise<Buffer> {
     const done = plugins.smartpromise.defer();
     let completeFile: Buffer;
     const replaySubject = await this.fastGetReplaySubject(optionsArg);
@@ -137,75 +157,78 @@ 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;
   }): Promise<plugins.smartrx.rxjs.ReplaySubject<Buffer>> {
-    const fileStream = await this.smartbucketRef.minioClient
+    const command = new plugins.s3.GetObjectCommand({
-      .getObject(this.name, optionsArg.path)
+      Bucket: this.name,
-      .catch((e) => console.log(e));
+      Key: optionsArg.path,
-    const replaySubject = new plugins.smartrx.rxjs.ReplaySubject<Buffer>();
-    const duplexStream = new plugins.smartstream.SmartDuplex<Buffer, void>({
-      writeFunction: async (chunk) => {
-        replaySubject.next(chunk);
-        return;
-      },
-      finalFunction: async (cb) => {
-        replaySubject.complete();
-        return;
-      }
     });
+    const response = await this.smartbucketRef.s3Client.send(command);
+    const replaySubject = new plugins.smartrx.rxjs.ReplaySubject<Buffer>();
 
-    if (!fileStream) {
+    // Convert the stream to a format that supports piping
-      return null;
+    const stream = response.Body as any; // SdkStreamMixin includes readable stream
+    if (typeof stream.pipe === 'function') {
+      const duplexStream = new plugins.smartstream.SmartDuplex<Buffer, void>({
+        writeFunction: async (chunk) => {
+          replaySubject.next(chunk);
+          return;
+        },
+        finalFunction: async (cb) => {
+          replaySubject.complete();
+          return;
+        },
+      });
+
+      stream.pipe(duplexStream);
     }
 
-    const smartstream = new plugins.smartstream.StreamWrapper([
-      fileStream,
-      duplexStream,
-    ]);
-    smartstream.run();
     return replaySubject;
   }
 
-  public fastGetStream(optionsArg: {
+  public fastGetStream(
-    path: string;
+    optionsArg: {
-  }, typeArg: 'webstream'): Promise<ReadableStream>
+      path: string;
-  public async fastGetStream(optionsArg: {
+    },
-    path: string;
+    typeArg: 'webstream'
-  }, typeArg: 'nodestream'): Promise<plugins.stream.Readable>
+  ): Promise<ReadableStream>;
+  public async fastGetStream(
+    optionsArg: {
+      path: string;
+    },
+    typeArg: 'nodestream'
+  ): Promise<plugins.stream.Readable>;
+
+  public async fastGetStream(
+    optionsArg: { path: string },
+    typeArg: 'webstream' | 'nodestream' = 'nodestream'
+  ): Promise<ReadableStream | plugins.stream.Readable> {
+    const command = new plugins.s3.GetObjectCommand({
+      Bucket: this.name,
+      Key: optionsArg.path,
+    });
+    const response = await this.smartbucketRef.s3Client.send(command);
+    const stream = response.Body as any; // SdkStreamMixin includes readable stream
 
-  /**
-   * fastGetStream
-   * @param optionsArg
-   * @returns 
-   */
-  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));
     const duplexStream = new plugins.smartstream.SmartDuplex<Buffer, Buffer>({
       writeFunction: async (chunk) => {
         return chunk;
       },
       finalFunction: async (cb) => {
         return null;
-      }
+      },
     });
 
-    if (!fileStream) {
+    if (typeof stream.pipe === 'function') {
-      return null;
+      stream.pipe(duplexStream);
     }
 
-    const smartstream = new plugins.smartstream.StreamWrapper([
-      fileStream,
-      duplexStream,
-    ]);
-    smartstream.run();
     if (typeArg === 'nodestream') {
       return duplexStream;
-    };
+    }
     if (typeArg === 'webstream') {
       return (await duplexStream.getWebStreams()).readable;
     }
@@ -221,41 +244,40 @@ export class Bucket {
     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.readableStream);
+      const command = new plugins.s3.PutObjectCommand({
-  
+        Bucket: this.name,
-      // Proceed with putting the object
+        Key: optionsArg.path,
-      await this.smartbucketRef.minioClient.putObject(
+        Body: optionsArg.readableStream,
-        this.name,
+        Metadata: optionsArg.nativeMetadata,
-        optionsArg.path,
+      });
-        streamIntake,
+      await this.smartbucketRef.s3Client.send(command);
-        null,
+
-        ...(optionsArg.nativeMetadata
+      console.log(
-          ? (() => {
+        `Object '${optionsArg.path}' has been successfully stored in bucket '${this.name}'.`
-              const returnObject: any = {};
-              return returnObject;
-            })()
-          : {})
       );
-  
-      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;
@@ -268,94 +290,105 @@ export class Bucket {
       const targetBucketName = optionsArg.targetBucket ? optionsArg.targetBucket.name : this.name;
 
       // Retrieve current object information to use in copy conditions
-      const currentObjInfo = await this.smartbucketRef.minioClient.statObject(
+      const currentObjInfo = await this.smartbucketRef.s3Client.send(
-        targetBucketName,
+        new plugins.s3.HeadObjectCommand({
-        optionsArg.sourcePath
+          Bucket: this.name,
+          Key: optionsArg.sourcePath,
+        })
       );
 
-      // Setting up copy conditions
-      const copyConditions = new plugins.minio.CopyConditions();
-
       // Prepare new metadata
       const newNativeMetadata = {
-        ...(optionsArg.deleteExistingNativeMetadata ? {} : currentObjInfo.metaData),
+        ...(optionsArg.deleteExistingNativeMetadata ? {} : currentObjInfo.Metadata),
         ...optionsArg.nativeMetadata,
       };
 
-      // Define the copy operation as a Promise
+      // Define the copy operation
-      // TODO: check on issue here: https://github.com/minio/minio-js/issues/1286
+      const copySource = `${this.name}/${optionsArg.sourcePath}`;
-      await this.smartbucketRef.minioClient.copyObject(
+      const command = new plugins.s3.CopyObjectCommand({
-        this.name,
+        Bucket: targetBucketName,
-        optionsArg.sourcePath,
+        CopySource: copySource,
-        `/${targetBucketName}/${optionsArg.destinationPath || optionsArg.sourcePath}`,
+        Key: optionsArg.destinationPath || optionsArg.sourcePath,
-        copyConditions
+        Metadata: newNativeMetadata,
-      );
+        MetadataDirective: optionsArg.deleteExistingNativeMetadata ? 'REPLACE' : 'COPY',
+      });
+      await this.smartbucketRef.s3Client.send(command);
     } catch (err) {
       console.error('Error updating metadata:', err);
       throw err; // rethrow to allow caller to handle
     }
   }
 
-    /**
+  /**
    * Move object from one path to another within the same bucket or to another bucket
    */
-    public async fastMove(optionsArg: {
+  public async fastMove(optionsArg: {
-      sourcePath: string;
+    sourcePath: string;
-      destinationPath: string;
+    destinationPath: string;
-      targetBucket?: Bucket;
+    targetBucket?: Bucket;
-      overwrite?: boolean;
+    overwrite?: boolean;
-    }): Promise<void> {
+  }): Promise<void> {
-      try {
+    try {
-        // Check if the destination object already exists
+      const destinationBucket = optionsArg.targetBucket || this;
-        const destinationBucket = optionsArg.targetBucket || this;
+      const exists = await destinationBucket.fastExists({ path: optionsArg.destinationPath });
-        const exists = await destinationBucket.fastExists({ path: optionsArg.destinationPath });
+
-  
+      if (exists && !optionsArg.overwrite) {
-        if (exists && !optionsArg.overwrite) {
+        console.error(
-          console.error(`Object already exists at destination path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`);
+          `Object already exists at destination path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`
-          return;
+        );
-        } else if (exists && optionsArg.overwrite) {
+        return;
-          console.log(`Overwriting existing object at destination path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`);
+      } else if (exists && optionsArg.overwrite) {
-        } else {
+        console.log(
-          console.log(`Moving object to path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`);
+          `Overwriting existing object at destination path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`
-        }
+        );
-  
+      } else {
-        // Proceed with copying the object to the new path
+        console.log(
-        await this.fastCopy(optionsArg);
+          `Moving object to path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`
-  
+        );
-        // 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;
       }
+
+      await this.fastCopy(optionsArg);
+      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: {
+  public async fastRemove(optionsArg: { path: string }) {
-    path: string;
+    const command = new plugins.s3.DeleteObjectCommand({
-  }) {
+      Bucket: this.name,
-    await this.smartbucketRef.minioClient.removeObject(this.name, optionsArg.path);
+      Key: optionsArg.path,
+    });
+    await this.smartbucketRef.s3Client.send(command);
   }
 
   /**
-   * check wether file exists
+   * check whether file exists
    * @param optionsArg
-   * @returns 
+   * @returns
    */
-  public async fastExists(optionsArg: {
+  public async fastExists(optionsArg: { path: string }): Promise<boolean> {
-    path: string;
-  }): Promise<boolean> {
     try {
-      await this.smartbucketRef.minioClient.statObject(this.name, optionsArg.path);
+      const command = new plugins.s3.HeadObjectCommand({
+        Bucket: this.name,
+        Key: optionsArg.path,
+      });
+      await this.smartbucketRef.s3Client.send(command);
       console.log(`Object '${optionsArg.path}' exists in bucket '${this.name}'.`);
       return true;
     } catch (error) {
-      if (error.code === 'NotFound') {
+      if (error.name === 'NotFound') {
         console.log(`Object '${optionsArg.path}' does not exist in bucket '${this.name}'.`);
         return false;
       } else {
@@ -369,59 +402,39 @@ export class Bucket {
    * deletes this bucket
    */
   public async delete() {
-    await this.smartbucketRef.minioClient.removeBucket(this.name);
+    await this.smartbucketRef.s3Client.send(
+      new plugins.s3.DeleteBucketCommand({ Bucket: this.name })
+    );
   }
 
   public async fastStat(pathDescriptor: interfaces.IPathDecriptor) {
-    let checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor);
+    const checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor);
-    return this.smartbucketRef.minioClient.statObject(this.name, checkPath);
+    const command = new plugins.s3.HeadObjectCommand({
+      Bucket: this.name,
+      Key: checkPath,
+    });
+    return this.smartbucketRef.s3Client.send(command);
   }
 
   public async isDirectory(pathDescriptor: interfaces.IPathDecriptor): Promise<boolean> {
-    let checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor);
+    const checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor);
-    
+    const command = new plugins.s3.ListObjectsV2Command({
-    // lets check if the checkPath is a directory
+      Bucket: this.name,
-    const stream = this.smartbucketRef.minioClient.listObjectsV2(this.name, checkPath, true);
+      Prefix: checkPath,
-    const done = plugins.smartpromise.defer<boolean>();
+      Delimiter: '/',
-    stream.on('data', (dataArg) => {
-      stream.destroy(); // Stop the stream early if we find at least one object
-      if (dataArg.prefix.startsWith(checkPath + '/')) {
-        done.resolve(true);
-      }
     });
-    
+    const response = await this.smartbucketRef.s3Client.send(command);
-    stream.on('end', () => {
+    return response.CommonPrefixes.length > 0;
-      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);
+    const checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor);
-    
+    const command = new plugins.s3.ListObjectsV2Command({
-    // lets check if the checkPath is a directory
+      Bucket: this.name,
-    const stream = this.smartbucketRef.minioClient.listObjectsV2(this.name, checkPath, true);
+      Prefix: checkPath,
-    const done = plugins.smartpromise.defer<boolean>();
+      Delimiter: '/',
-    stream.on('data', (dataArg) => {
-      stream.destroy(); // Stop the stream early if we find at least one object
-      if (dataArg.prefix === checkPath) {
-        done.resolve(true);
-      }
     });
-    
+    const response = await this.smartbucketRef.s3Client.send(command);
-    stream.on('end', () => {
+    return response.Contents.length > 0;
-      done.resolve(false);
-    });
-    
-    stream.on('error', (err) => {
-      done.reject(err);
-    });
-
-    return done.promise;
   }
 }

ts/classes.directory.ts

@@ -1,6 +1,9 @@
+// classes.directory.ts
+
 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;
@@ -11,9 +14,9 @@ export class Directory {
   public files: string[];
   public folders: string[];
 
-  constructor(bucketRefArg: Bucket, parentDiretory: Directory, name: string) {
+  constructor(bucketRefArg: Bucket, parentDirectory: Directory, name: string) {
     this.bucketRef = bucketRefArg;
-    this.parentDirectoryRef = parentDiretory;
+    this.parentDirectoryRef = parentDirectory;
     this.name = name;
   }
 
@@ -63,53 +66,53 @@ export class Directory {
    * gets a file by name
    */
   public async getFile(optionsArg: {
-    name: string;
+    path: string;
     createWithContents?: string | Buffer;
+    getFromTrash?: boolean;
   }): Promise<File> {
-    // check wether the file exists
+    const pathDescriptor = {
+      directory: this,
+      path: optionsArg.path,
+    };
     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 File.create({
         directory: this,
-        name: optionsArg.name,
+        name: optionsArg.path,
         contents: optionsArg.createWithContents,
       });
     }
     return new File({
       directoryRefArg: this,
-      fileName: optionsArg.name,
+      fileName: optionsArg.path,
-    })
+    });
   }
 
   /**
    * lists all files
    */
   public async listFiles(): Promise<File[]> {
-    const done = plugins.smartpromise.defer();
+    const command = new plugins.s3.ListObjectsV2Command({
-    const fileNameStream = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
+      Bucket: this.bucketRef.name,
-      this.bucketRef.name,
+      Prefix: this.getBasePath(),
-      this.getBasePath(),
+      Delimiter: '/',
-      false
+    });
-    );
+    const response = await this.bucketRef.smartbucketRef.s3Client.send(command);
     const fileArray: File[] = [];
-    const duplexStream = new plugins.smartstream.SmartDuplex<plugins.minio.BucketItem, void>({
+
-      objectMode: true,
+    response.Contents.forEach((item) => {
-      writeFunction: async (bucketItem) => {
+      if (item.Key && !item.Key.endsWith('/')) {
-        if (bucketItem.prefix) {
+        const subtractedPath = item.Key.replace(this.getBasePath(), '');
-          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({
@@ -118,13 +121,9 @@ export class Directory {
             })
           );
         }
-      },
-      finalFunction: async (tools) => {
-        done.resolve();
       }
     });
-    fileNameStream.pipe(duplexStream);
+
-    await done.promise;
     return fileArray;
   }
 
@@ -132,54 +131,52 @@ export class Directory {
    * lists all folders
    */
   public async listDirectories(): Promise<Directory[]> {
-    const done = plugins.smartpromise.defer();
+    try {
-    const basePath = this.getBasePath();
+      const command = new plugins.s3.ListObjectsV2Command({
-    const completeDirStream = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
+        Bucket: this.bucketRef.name,
-      this.bucketRef.name,
+        Prefix: this.getBasePath(),
-      this.getBasePath(),
+        Delimiter: '/',
-      false
+      });
-    );
+      const response = await this.bucketRef.smartbucketRef.s3Client.send(command);
-    const directoryArray: Directory[] = [];
+      const directoryArray: Directory[] = [];
-    const duplexStream = new plugins.smartstream.SmartDuplex<plugins.minio.BucketItem, void>({
+  
-      objectMode: true,
+      if (response.CommonPrefixes) {
-      writeFunction: async (bucketItem) => {
+        response.CommonPrefixes.forEach((item) => {
-        if (bucketItem.name) {
+          if (item.Prefix) {
-          return;
+            const subtractedPath = item.Prefix.replace(this.getBasePath(), '');
-        }
+            if (subtractedPath.endsWith('/')) {
-        let subtractedPath = bucketItem.prefix.replace(this.getBasePath(), '');
+              const dirName = subtractedPath.slice(0, -1);
-        if (subtractedPath.startsWith('/')) {
+              // Ensure the directory name is not empty (which would indicate the base directory itself)
-          subtractedPath = subtractedPath.substr(1);
+              if (dirName) {
-        }
+                directoryArray.push(new Directory(this.bucketRef, this, dirName));
-        if (subtractedPath.includes('/')) {
+              }
-          const dirName = subtractedPath.split('/')[0];
+            }
-          if (directoryArray.find((directory) => directory.name === dirName)) {
-            return;
           }
-          directoryArray.push(new Directory(this.bucketRef, this, dirName));
+        });
-        }
-      },
-      finalFunction: async (tools) => {
-        done.resolve();
       }
-    });
+  
-    completeDirStream.pipe(duplexStream);
+      return directoryArray;
-    await done.promise;
+    } catch (error) {
-    return directoryArray;
+      console.error('Error listing directories:', error);
+      throw error;
+    }
   }
 
   /**
-   * gets an array that has all objects with a certain prefix;
+   * gets an array that has all objects with a certain prefix
    */
   public async getTreeArray() {
-    const treeArray = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
+    const command = new plugins.s3.ListObjectsV2Command({
-      this.bucketRef.name,
+      Bucket: this.bucketRef.name,
-      this.getBasePath(),
+      Prefix: this.getBasePath(),
-      true
+      Delimiter: '/',
-    );
+    });
+    const response = await this.bucketRef.smartbucketRef.s3Client.send(command);
+    return response.Contents;
   }
 
   /**
-   * gets a sub directory
+   * gets a sub directory by name
    */
   public async getSubDirectoryByName(dirNameArg: string): Promise<Directory> {
     const dirNameArray = dirNameArg.split('/');
@@ -190,11 +187,13 @@ export class 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;
   }
 
@@ -203,19 +202,20 @@ export class Directory {
    */
   public async move() {
     // TODO
-    throw new Error('moving a directory is not yet implemented');
+    throw new Error('Moving a directory is not yet implemented');
   }
 
   /**
-   * creates a file within this directory
+   * creates an empty file within this directory
    * @param relativePathArg
    */
   public async createEmptyFile(relativePathArg: string) {
-    const emtpyFile = await File.create({
+    const emptyFile = await File.create({
       directory: this,
       name: relativePathArg,
       contents: '',
     });
+    return emptyFile;
   }
 
   // file operations
@@ -235,23 +235,35 @@ export class Directory {
     return result;
   }
 
-  public fastGetStream(optionsArg: {
+  public fastGetStream(
-    path: string;
+    optionsArg: {
-  }, typeArg: 'webstream'): Promise<ReadableStream>
+      path: string;
-  public async fastGetStream(optionsArg: {
+    },
-    path: string;
+    typeArg: 'webstream'
-  }, typeArg: 'nodestream'): Promise<plugins.stream.Readable>
+  ): 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({
+    const result = await this.bucketRef.fastGetStream(
-      path
+      {
-    }, typeArg as any);
+        path,
+      },
+      typeArg as any
+    );
     return result;
   }
 
@@ -271,23 +283,34 @@ export class Directory {
 
   /**
    * removes a file within the directory
+   * uses file class to make sure effects for metadata etc. are handled correctly
    * @param optionsArg
    */
-  public async fastRemove(optionsArg: { path: string }) {
+  public async fastRemove(optionsArg: {
-    const path = plugins.path.join(this.getBasePath(), optionsArg.path);
+    path: string
-    await this.bucketRef.fastRemove({
+    /**
-      path,
+     * wether the file should be placed into trash. Default is false.
+     */
+    mode?: 'permanent' | 'trash';
+  }) {
+    const file = await this.getFile({
+      path: optionsArg.path,
+    });
+    await file.delete({
+      mode: optionsArg.mode ? optionsArg.mode : 'permanent',
     });
   }
 
   /**
    * deletes the directory with all its contents
    */
-  public async delete() {
+  public async delete(optionsArg: {
+    mode?: 'permanent' | 'trash';
+  }) {
     const deleteDirectory = async (directoryArg: Directory) => {
       const childDirectories = await directoryArg.listDirectories();
       if (childDirectories.length === 0) {
-        console.log('directory empty! Path complete!');
+        console.log('Directory empty! Path complete!');
       } else {
         for (const childDir of childDirectories) {
           await deleteDirectory(childDir);
@@ -295,9 +318,9 @@ export class Directory {
       }
       const files = await directoryArg.listFiles();
       for (const file of files) {
-        await directoryArg.fastRemove({
+        await file.delete({
-          path: file.name,
+          mode: optionsArg.mode ? optionsArg.mode : 'permanent',
-        });
+        })
       }
     };
     await deleteDirectory(this);

ts/classes.file.ts

@@ -116,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(),
+        directory: await trash.getTrashDir(),
-        path: plugins.path.join('trash', trashName),
+        path: await trash.getTrashKeyByOriginalBasePath(this.getBasePath()),
       });
     }
     

ts/classes.metadata.ts

@@ -10,7 +10,7 @@ export class MetaData {
 
     // lets find the existing metadata file
     metaData.metadataFile = await metaData.fileRef.parentDirectoryRef.getFile({
-      name: metaData.fileRef.name + '.metadata',
+      path: metaData.fileRef.name + '.metadata',
       createWithContents: '{}',
     });
 
@@ -21,12 +21,12 @@ export class MetaData {
   /**
    * the file that contains the metadata
    */
-  metadataFile: File;
+  metadataFile!: File;
 
   /**
    * the file that the metadata is for
    */
-  fileRef: File;
+  fileRef!: File;
 
   public async getFileType(optionsArg?: {
     useFileExtension?: boolean;
@@ -44,13 +44,13 @@ export class MetaData {
     const stat = await this.fileRef.parentDirectoryRef.bucketRef.fastStat({
       path: this.fileRef.getBasePath(),
     });
-    return stat.size;
+    return stat.ContentLength!;
   }
 
   private prefixCustomMetaData = 'custom_';
 
   public async storeCustomMetaData<T = any>(optionsArg: { key: string; value: T }) {
-    const data = await this.metadataFile.getContentsAsString();
+    const data = await this.metadataFile.getJsonData();
     data[this.prefixCustomMetaData + optionsArg.key] = optionsArg.value;
     await this.metadataFile.writeJsonData(data);
   }

ts/classes.smartbucket.ts

@@ -1,22 +1,34 @@
+// classes.smartbucket.ts
+
 import * as plugins from './plugins.js';
 import { Bucket } from './classes.bucket.js';
 
 export class SmartBucket {
   public config: plugins.tsclass.storage.IS3Descriptor;
 
-  public minioClient: plugins.minio.Client;
+  public s3Client: plugins.s3.S3Client;
 
+  /**
+   * the constructor of SmartBucket
+   */
   /**
    * the constructor of SmartBucket
    */
   constructor(configArg: plugins.tsclass.storage.IS3Descriptor) {
     this.config = configArg;
-    this.minioClient = new plugins.minio.Client({
+
-      endPoint: this.config.endpoint,
+    const protocol = configArg.useSsl === false ? 'http' : 'https';
-      port: configArg.port || 443,
+    const port = configArg.port ? `:${configArg.port}` : '';
-      useSSL: configArg.useSsl !== undefined ? configArg.useSsl : true,
+    const endpoint = `${protocol}://${configArg.endpoint}${port}`;
-      accessKey: this.config.accessKey,
+
-      secretKey: this.config.accessSecret,
+    this.s3Client = new plugins.s3.S3Client({
+      endpoint,
+      region: configArg.region || 'us-east-1',
+      credentials: {
+        accessKeyId: configArg.accessKey,
+        secretAccessKey: configArg.accessSecret,
+      },
+      forcePathStyle: true, // Necessary for S3-compatible storage like MinIO or Wasabi
     });
   }
 

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({ path: trashKey });
+  }
+
+  public async getTrashKeyByOriginalBasePath (originalPath: string): Promise<string> {
+    return plugins.smartstring.base64.encode(originalPath);
+  }
+}

ts/plugins.ts

@@ -1,3 +1,5 @@
+// plugins.ts
+
 // node native
 import * as path from 'path';
 import * as stream from 'stream';
@@ -10,9 +12,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';
@@ -22,6 +25,8 @@ export {
 }
 
 // third party scope
-import * as minio from 'minio';
+import * as s3 from '@aws-sdk/client-s3';
 
-export { minio };
+export {
+  s3,
+}

tsconfig.json

@@ -6,7 +6,8 @@
     "module": "NodeNext",
     "moduleResolution": "NodeNext",
     "esModuleInterop": true,
-    "verbatimModuleSyntax": true
+    "verbatimModuleSyntax": true,
+    "strict": true
   },
   "exclude": [
     "dist_*/**/*.d.ts"