3.0.18

npmextra.json

@@ -8,25 +8,28 @@
       "githost": "code.foss.global",
       "gitscope": "push.rocks",
       "gitrepo": "smartbucket",
-      "description": "A TypeScript library that offers simple, cloud-independent object storage with features like bucket creation, file management, and directory management.",
+      "description": "A TypeScript library offering simple and cloud-agnostic object storage with advanced features like bucket creation, file and directory management, and data streaming.",
       "npmPackagename": "@push.rocks/smartbucket",
       "license": "MIT",
       "keywords": [
+        "TypeScript",
         "cloud storage",
         "object storage",
-        "TypeScript",
+        "bucket creation",
-        "S3",
-        "minio",
         "file management",
         "directory management",
-        "bucket creation",
         "data streaming",
         "multi-cloud",
         "API",
         "unified storage",
+        "S3",
+        "minio",
+        "file locking",
+        "metadata",
         "buffer handling",
         "access key",
-        "secret key"
+        "secret key",
+        "cloud agnostic"
       ]
     }
   },

package-lock.json

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

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@push.rocks/smartbucket",
-  "version": "3.0.3",
+  "version": "3.0.18",
-  "description": "A TypeScript library that offers simple, cloud-independent object storage with features like bucket creation, file management, and directory management.",
+  "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",
   "type": "module",
@@ -19,12 +19,15 @@
     "@push.rocks/tapbundle": "^5.0.23"
   },
   "dependencies": {
+    "@aws-sdk/client-s3": "^3.598.0",
+    "@push.rocks/smartmime": "^2.0.2",
     "@push.rocks/smartpath": "^5.0.18",
     "@push.rocks/smartpromise": "^4.0.3",
     "@push.rocks/smartrx": "^3.0.7",
-    "@push.rocks/smartstream": "^3.0.38",
+    "@push.rocks/smartstream": "^3.0.44",
-    "@tsclass/tsclass": "^4.0.54",
+    "@push.rocks/smartstring": "^4.0.15",
-    "minio": "^8.0.0"
+    "@push.rocks/smartunique": "^3.0.9",
+    "@tsclass/tsclass": "^4.0.59"
   },
   "private": false,
   "files": [
@@ -43,20 +46,28 @@
     "last 1 chrome versions"
   ],
   "keywords": [
+    "TypeScript",
     "cloud storage",
     "object storage",
-    "TypeScript",
+    "bucket creation",
-    "S3",
-    "minio",
     "file management",
     "directory management",
-    "bucket creation",
     "data streaming",
     "multi-cloud",
     "API",
     "unified storage",
+    "S3",
+    "minio",
+    "file locking",
+    "metadata",
     "buffer handling",
     "access key",
-    "secret key"
+    "secret key",
-  ]
+    "cloud agnostic"
+  ],
+  "homepage": "https://code.foss.global/push.rocks/smartbucket",
+  "repository": {
+    "type": "git",
+    "url": "https://code.foss.global/push.rocks/smartbucket.git"
+  }
 }

readme.md

@@ -1,9 +1,10 @@
 # @push.rocks/smartbucket
-A TypeScript library for simple cloud independent object storage with support for buckets, directories, and files.
+
+A TypeScript library for cloud-independent object storage, providing features like bucket creation, file and directory management, and data streaming.
 
 ## Install
 
-To install `@push.rocks/smartbucket`, you need to have Node.js and npm (Node Package Manager) installed on your system. If you have them installed, you can add `@push.rocks/smartbucket` to your project by running the following command in your project's root directory:
+To install `@push.rocks/smartbucket`, you need to have Node.js and npm (Node Package Manager) installed. If they are installed, you can add `@push.rocks/smartbucket` to your project by running the following command in your project's root directory:
 
 ```bash
 npm install @push.rocks/smartbucket --save
@@ -13,7 +14,7 @@ This command will download and install `@push.rocks/smartbucket` along with its
 
 ## Usage
 
-`@push.rocks/smartbucket` is a TypeScript module designed to provide simple cloud-independent object storage functionality. It wraps various cloud storage providers such as AWS S3, Google Cloud Storage, and others, offering a unified API to manage storage buckets and objects within those buckets. 
+`@push.rocks/smartbucket` is a TypeScript module designed to provide simple cloud-independent object storage functionality. It wraps various cloud storage providers such as AWS S3, Google Cloud Storage, and others, offering a unified API to manage storage buckets and objects within those buckets.
 
 In this guide, we will delve into the usage of SmartBucket, covering its full range of features from setting up the library to advanced usage scenarios.
 
@@ -48,7 +49,7 @@ const mySmartBucket = new SmartBucket({
   accessKey: "yourAccessKey",
   accessSecret: "yourSecretKey",
   endpoint: "yourEndpointURL",
-  port: 443,            // Default is 443, could be customized for specific endpoint
+  port: 443,            // Default is 443, can be customized for specific endpoint
   useSsl: true          // Defaults to true
 });
 ```
@@ -189,7 +190,7 @@ async function writeFileStream(bucketName: string, filePath: string, readableStr
 // Create a readable stream from a string
 const readable = new Readable();
 readable.push('Hello world streamed as a file!');
-readable.push(null); // Indicates end of the stream
+readable.push(null); // End of stream
 
 // Use the function
 writeFileStream("exampleBucket", "path/to/streamedObject.txt", readable);
@@ -197,7 +198,9 @@ writeFileStream("exampleBucket", "path/to/streamedObject.txt", readable);
 
 ### Working with Directories
 
-`@push.rocks/smartbucket` abstracts directories within buckets for easier object management. You can create, list, and delete directories using the `Directory` class.
+`@push.rocks/smartbucket` offers abstractions for directories within buckets for easier object management. You can create, list, and delete directories using the `Directory` class.
+
+To list the contents of a directory:
 
 ```typescript
 async function listDirectoryContents(bucketName: string, directoryPath: string) {
@@ -205,6 +208,7 @@ async function listDirectoryContents(bucketName: string, directoryPath: string)
   if (myBucket) {
     const baseDirectory: Directory = await myBucket.getBaseDirectory();
     const targetDirectory: Directory = await baseDirectory.getSubDirectoryByName(directoryPath);
+    
     console.log('Listing directories:');
     const directories = await targetDirectory.listDirectories();
     directories.forEach(dir => {
@@ -250,11 +254,11 @@ createFileInDirectory("exampleBucket", "some/directory", "newfile.txt", "Hello,
 
 #### Bucket Policies
 
-Manage bucket policies to control access permissions. This feature is dependent on the policies provided by the storage service (e.g., AWS S3, MinIO).
+Manage bucket policies to control access permissions. This feature depends on the policies provided by the storage service (e.g., AWS S3, MinIO).
 
 #### Object Metadata
 
-You can retrieve and modify object metadata. Metadata can be useful for storing additional information about an object.
+Retrieve and modify object metadata. Metadata can be useful for storing additional information about an object.
 
 To retrieve metadata:
 

test/test.ts

@@ -45,7 +45,7 @@ tap.test('should get data in bucket', async () => {
   });
   const fileStringStream = await myBucket.fastGetStream({
     path: 'hithere/socool.txt',
-  });
+  }, 'nodestream');
   console.log(fileString);
 });
 
@@ -79,7 +79,7 @@ tap.test('prepare for directory style tests', async () => {
     contents: 'dir3/dir4/file1.txt content',
   });
   await myBucket.fastPut({
-    path: 'file1.txt',
+    path: '/file1.txt',
     contents: 'file1 content',
   });
 });

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartbucket',
-  version: '3.0.3',
+  version: '3.0.18',
-  description: 'A TypeScript library that offers simple, cloud-independent object storage with features like bucket creation, file management, and directory management.'
+  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

@@ -0,0 +1,439 @@
+// 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 command = new plugins.s3.ListBucketsCommand({});
+    const buckets = await smartbucketRef.s3Client.send(command);
+    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 {
+      return null;
+    }
+  }
+
+  public static async createBucketByName(smartbucketRef: SmartBucket, bucketName: string) {
+    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) {
+    const command = new plugins.s3.DeleteBucketCommand({ Bucket: bucketName });
+    await smartbucketRef.s3Client.send(command).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(): Promise<Directory> {
+    return new Directory(this, null, '');
+  }
+
+  /**
+   * 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();
+    }
+    const checkPath = await helpers.reducePathDescriptorToPath(pathDescriptorArg);
+    const baseDirectory = await this.getBaseDirectory();
+    return await baseDirectory.getSubDirectoryByName(checkPath);
+  }
+
+  // ===============
+  // Fast Operations
+  // ===============
+
+  /**
+   * store file
+   */
+  public async fastPut(
+    optionsArg: interfaces.IPathDecriptor & {
+      contents: string | Buffer;
+      overwrite?: boolean;
+    }
+  ): Promise<File> {
+    try {
+      const reducedPath = await helpers.reducePathDescriptorToPath(optionsArg);
+      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}'.`
+        );
+      } else {
+        console.log(`Creating new object at path '${reducedPath}' in bucket '${this.name}'.`);
+      }
+
+      const command = new plugins.s3.PutObjectCommand({
+        Bucket: this.name,
+        Key: reducedPath,
+        Body: optionsArg.contents,
+      });
+      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({
+        directoryRefArg: await this.getDirectoryFromPath({
+          path: parsedPath.dir,
+        }),
+        fileName: parsedPath.base,
+      });
+    } catch (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> {
+    const done = plugins.smartpromise.defer();
+    let completeFile: Buffer;
+    const replaySubject = await this.fastGetReplaySubject(optionsArg);
+    const subscription = replaySubject.subscribe({
+      next: (chunk) => {
+        if (completeFile) {
+          completeFile = Buffer.concat([completeFile, chunk]);
+        } else {
+          completeFile = chunk;
+        }
+      },
+      complete: () => {
+        done.resolve();
+        subscription.unsubscribe();
+      },
+      error: (err) => {
+        console.log(err);
+      },
+    });
+    await done.promise;
+    return completeFile;
+  }
+
+  /**
+   * good when time to first byte is important
+   * and multiple subscribers are expected
+   * @param optionsArg
+   * @returns
+   */
+  public async fastGetReplaySubject(optionsArg: {
+    path: string;
+  }): Promise<plugins.smartrx.rxjs.ReplaySubject<Buffer>> {
+    const command = new plugins.s3.GetObjectCommand({
+      Bucket: this.name,
+      Key: optionsArg.path,
+    });
+    const response = await this.smartbucketRef.s3Client.send(command);
+    const replaySubject = new plugins.smartrx.rxjs.ReplaySubject<Buffer>();
+
+    // Convert the stream to a format that supports piping
+    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);
+    }
+
+    return replaySubject;
+  }
+
+  public fastGetStream(
+    optionsArg: {
+      path: string;
+    },
+    typeArg: 'webstream'
+  ): 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
+
+    const duplexStream = new plugins.smartstream.SmartDuplex<Buffer, Buffer>({
+      writeFunction: async (chunk) => {
+        return chunk;
+      },
+      finalFunction: async (cb) => {
+        return null;
+      },
+    });
+
+    if (typeof stream.pipe === 'function') {
+      stream.pipe(duplexStream);
+    }
+
+    if (typeArg === 'nodestream') {
+      return duplexStream;
+    }
+    if (typeArg === 'webstream') {
+      return (await duplexStream.getWebStreams()).readable;
+    }
+  }
+
+  /**
+   * store file as stream
+   */
+  public async fastPutStream(optionsArg: {
+    path: string;
+    readableStream: plugins.stream.Readable | ReadableStream;
+    nativeMetadata?: { [key: string]: string };
+    overwrite?: boolean;
+  }): Promise<void> {
+    try {
+      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}'.`
+        );
+        return;
+      } else if (exists && optionsArg.overwrite) {
+        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 command = new plugins.s3.PutObjectCommand({
+        Bucket: this.name,
+        Key: optionsArg.path,
+        Body: optionsArg.readableStream,
+        Metadata: optionsArg.nativeMetadata,
+      });
+      await this.smartbucketRef.s3Client.send(command);
+
+      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
+      );
+      throw error;
+    }
+  }
+
+  public async fastCopy(optionsArg: {
+    sourcePath: string;
+    destinationPath?: string;
+    targetBucket?: Bucket;
+    nativeMetadata?: { [key: string]: string };
+    deleteExistingNativeMetadata?: boolean;
+  }): Promise<void> {
+    try {
+      const targetBucketName = optionsArg.targetBucket ? optionsArg.targetBucket.name : this.name;
+
+      // Retrieve current object information to use in copy conditions
+      const currentObjInfo = await this.smartbucketRef.s3Client.send(
+        new plugins.s3.HeadObjectCommand({
+          Bucket: this.name,
+          Key: optionsArg.sourcePath,
+        })
+      );
+
+      // Prepare new metadata
+      const newNativeMetadata = {
+        ...(optionsArg.deleteExistingNativeMetadata ? {} : currentObjInfo.Metadata),
+        ...optionsArg.nativeMetadata,
+      };
+
+      // Define the copy operation
+      const copySource = `${this.name}/${optionsArg.sourcePath}`;
+      const command = new plugins.s3.CopyObjectCommand({
+        Bucket: targetBucketName,
+        CopySource: copySource,
+        Key: optionsArg.destinationPath || optionsArg.sourcePath,
+        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: {
+    sourcePath: string;
+    destinationPath: string;
+    targetBucket?: Bucket;
+    overwrite?: boolean;
+  }): Promise<void> {
+    try {
+      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}'.`
+        );
+      }
+
+      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: { path: string }) {
+    const command = new plugins.s3.DeleteObjectCommand({
+      Bucket: this.name,
+      Key: optionsArg.path,
+    });
+    await this.smartbucketRef.s3Client.send(command);
+  }
+
+  /**
+   * check whether file exists
+   * @param optionsArg
+   * @returns
+   */
+  public async fastExists(optionsArg: { path: string }): Promise<boolean> {
+    try {
+      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.name === 'NotFound') {
+        console.log(`Object '${optionsArg.path}' does not exist in bucket '${this.name}'.`);
+        return false;
+      } else {
+        console.error('Error checking object existence:', error);
+        throw error; // Rethrow if it's not a NotFound error to handle unexpected issues
+      }
+    }
+  }
+
+  /**
+   * deletes this bucket
+   */
+  public async delete() {
+    await this.smartbucketRef.s3Client.send(
+      new plugins.s3.DeleteBucketCommand({ Bucket: this.name })
+    );
+  }
+
+  public async fastStat(pathDescriptor: interfaces.IPathDecriptor) {
+    const checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor);
+    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> {
+    const checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor);
+    const command = new plugins.s3.ListObjectsV2Command({
+      Bucket: this.name,
+      Prefix: checkPath,
+      Delimiter: '/',
+    });
+    const response = await this.smartbucketRef.s3Client.send(command);
+    return response.CommonPrefixes.length > 0;
+  }
+
+  public async isFile(pathDescriptor: interfaces.IPathDecriptor): Promise<boolean> {
+    const checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor);
+    const command = new plugins.s3.ListObjectsV2Command({
+      Bucket: this.name,
+      Prefix: checkPath,
+      Delimiter: '/',
+    });
+    const response = await this.smartbucketRef.s3Client.send(command);
+    return response.Contents.length > 0;
+  }
+}

ts/classes.directory.ts

@@ -0,0 +1,317 @@
+// 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;
+  public parentDirectoryRef: Directory;
+  public name: string;
+
+  public tree: string[];
+  public files: string[];
+  public folders: string[];
+
+  constructor(bucketRefArg: Bucket, parentDirectory: Directory, name: string) {
+    this.bucketRef = bucketRefArg;
+    this.parentDirectoryRef = parentDirectory;
+    this.name = name;
+  }
+
+  /**
+   * returns an array of parent directories
+   */
+  public getParentDirectories(): Directory[] {
+    let parentDirectories: Directory[] = [];
+    if (this.parentDirectoryRef) {
+      parentDirectories.push(this.parentDirectoryRef);
+      parentDirectories = parentDirectories.concat(this.parentDirectoryRef.getParentDirectories());
+    }
+    return parentDirectories;
+  }
+
+  /**
+   * returns the directory level
+   */
+  public getDirectoryLevel(): number {
+    return this.getParentDirectories().length;
+  }
+
+  /**
+   * updates the base path
+   */
+  public getBasePath(): string {
+    const parentDirectories = this.getParentDirectories();
+    let basePath = '';
+    for (const parentDir of parentDirectories) {
+      if (!parentDir.name && !basePath) {
+        basePath = this.name + '/';
+        continue;
+      }
+      if (parentDir.name && !basePath) {
+        basePath = parentDir.name + '/' + this.name + '/';
+        continue;
+      }
+      if (parentDir.name && basePath) {
+        basePath = parentDir.name + '/' + basePath;
+        continue;
+      }
+    }
+    return basePath;
+  }
+
+  /**
+   * gets a file by name
+   */
+  public async getFile(optionsArg: {
+    name: string;
+    createWithContents?: string | Buffer;
+    getFromTrash?: boolean;
+  }): Promise<File> {
+    const pathDescriptor = {
+      directory: this,
+      path: optionsArg.name,
+    };
+    const exists = await this.bucketRef.fastExists({
+      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,
+        contents: optionsArg.createWithContents,
+      });
+    }
+    return new File({
+      directoryRefArg: this,
+      fileName: optionsArg.name,
+    });
+  }
+
+  /**
+   * lists all files
+   */
+  public async listFiles(): Promise<File[]> {
+    const command = new plugins.s3.ListObjectsV2Command({
+      Bucket: this.bucketRef.name,
+      Prefix: this.getBasePath(),
+      Delimiter: '/',
+    });
+    const response = await this.bucketRef.smartbucketRef.s3Client.send(command);
+    const fileArray: File[] = [];
+
+    response.Contents.forEach((item) => {
+      if (item.Key && !item.Key.endsWith('/')) {
+        const subtractedPath = item.Key.replace(this.getBasePath(), '');
+        if (!subtractedPath.includes('/')) {
+          fileArray.push(
+            new File({
+              directoryRefArg: this,
+              fileName: subtractedPath,
+            })
+          );
+        }
+      }
+    });
+
+    return fileArray;
+  }
+
+  /**
+   * lists all folders
+   */
+  public async listDirectories(): Promise<Directory[]> {
+    try {
+      const command = new plugins.s3.ListObjectsV2Command({
+        Bucket: this.bucketRef.name,
+        Prefix: this.getBasePath(),
+        Delimiter: '/',
+      });
+      const response = await this.bucketRef.smartbucketRef.s3Client.send(command);
+      const directoryArray: Directory[] = [];
+  
+      if (response.CommonPrefixes) {
+        response.CommonPrefixes.forEach((item) => {
+          if (item.Prefix) {
+            const subtractedPath = item.Prefix.replace(this.getBasePath(), '');
+            if (subtractedPath.endsWith('/')) {
+              const dirName = subtractedPath.slice(0, -1);
+              // Ensure the directory name is not empty (which would indicate the base directory itself)
+              if (dirName) {
+                directoryArray.push(new Directory(this.bucketRef, this, dirName));
+              }
+            }
+          }
+        });
+      }
+  
+      return directoryArray;
+    } catch (error) {
+      console.error('Error listing directories:', error);
+      throw error;
+    }
+  }
+
+  /**
+   * gets an array that has all objects with a certain prefix
+   */
+  public async getTreeArray() {
+    const command = new plugins.s3.ListObjectsV2Command({
+      Bucket: this.bucketRef.name,
+      Prefix: this.getBasePath(),
+      Delimiter: '/',
+    });
+    const response = await this.bucketRef.smartbucketRef.s3Client.send(command);
+    return response.Contents;
+  }
+
+  /**
+   * gets a sub directory by name
+   */
+  public async getSubDirectoryByName(dirNameArg: string): Promise<Directory> {
+    const dirNameArray = dirNameArg.split('/');
+
+    const getDirectory = async (directoryArg: Directory, dirNameToSearch: string) => {
+      const directories = await directoryArg.listDirectories();
+      return directories.find((directory) => {
+        return directory.name === dirNameToSearch;
+      });
+    };
+
+    let wantedDirectory: Directory;
+    for (const dirNameToSearch of dirNameArray) {
+      const directoryToSearchIn = wantedDirectory ? wantedDirectory : this;
+      wantedDirectory = await getDirectory(directoryToSearchIn, dirNameToSearch);
+    }
+
+    return wantedDirectory;
+  }
+
+  /**
+   * moves the directory
+   */
+  public async move() {
+    // TODO
+    throw new Error('Moving a directory is not yet implemented');
+  }
+
+  /**
+   * creates an empty file within this directory
+   * @param relativePathArg
+   */
+  public async createEmptyFile(relativePathArg: string) {
+    const emptyFile = await File.create({
+      directory: this,
+      name: relativePathArg,
+      contents: '',
+    });
+    return emptyFile;
+  }
+
+  // file operations
+  public async fastPut(optionsArg: { path: string; contents: string | Buffer }) {
+    const path = plugins.path.join(this.getBasePath(), optionsArg.path);
+    await this.bucketRef.fastPut({
+      path,
+      contents: optionsArg.contents,
+    });
+  }
+
+  public async fastGet(optionsArg: { path: string }) {
+    const path = plugins.path.join(this.getBasePath(), optionsArg.path);
+    const result = await this.bucketRef.fastGet({
+      path,
+    });
+    return result;
+  }
+
+  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
+   */
+  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
+    );
+    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
+   */
+  public async fastRemove(optionsArg: { path: string }) {
+    const path = plugins.path.join(this.getBasePath(), optionsArg.path);
+    await this.bucketRef.fastRemove({
+      path,
+    });
+  }
+
+  /**
+   * deletes the directory with all its contents
+   */
+  public async delete() {
+    const deleteDirectory = async (directoryArg: Directory) => {
+      const childDirectories = await directoryArg.listDirectories();
+      if (childDirectories.length === 0) {
+        console.log('Directory empty! Path complete!');
+      } else {
+        for (const childDir of childDirectories) {
+          await deleteDirectory(childDir);
+        }
+      }
+      const files = await directoryArg.listFiles();
+      for (const file of files) {
+        await directoryArg.fastRemove({
+          path: file.name,
+        });
+      }
+    };
+    await deleteDirectory(this);
+  }
+}

ts/classes.file.ts

@@ -0,0 +1,233 @@
+import * as plugins from './plugins.js';
+import * as helpers from './helpers.js';
+import * as interfaces from './interfaces.js';
+import { Directory } from './classes.directory.js';
+import { MetaData } from './classes.metadata.js';
+
+/**
+ * represents a file in a directory
+ */
+export class File {
+  // STATIC
+
+  /**
+   * creates a file in draft mode
+   * you need to call .save() to store it in s3
+   * @param optionsArg
+   */
+  public static async create(optionsArg: {
+    directory: Directory;
+    name: string;
+    contents: Buffer | string | plugins.stream.Readable;
+    /**
+     * if contents are of type string, you can specify the encoding here
+     */
+    encoding?: 'utf8' | 'binary';
+  }): Promise<File> {
+    const contents =
+      typeof optionsArg.contents === 'string'
+        ? Buffer.from(optionsArg.contents, optionsArg.encoding)
+        : optionsArg.contents;
+    const file = new File({
+      directoryRefArg: optionsArg.directory,
+      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,
+        contents: contents,
+      });
+    }
+    return file;
+  }
+
+  // INSTANCE
+  public parentDirectoryRef: Directory;
+  public name: string;
+
+  public getBasePath(): string {
+    return plugins.path.join(this.parentDirectoryRef.getBasePath(), this.name);
+  }
+
+  constructor(optionsArg: { directoryRefArg: Directory; fileName: string }) {
+    this.parentDirectoryRef = optionsArg.directoryRefArg;
+    this.name = optionsArg.fileName;
+  }
+
+  public async getContentsAsString(): Promise<string> {
+    const fileBuffer = await this.getContents();
+    return fileBuffer.toString();
+  }
+
+  public async getContents(): Promise<Buffer> {
+    const resultBuffer = await this.parentDirectoryRef.bucketRef.fastGet({
+      path: this.getBasePath(),
+    });
+    return resultBuffer;
+  }
+
+  public async getReadStream(typeArg: 'webstream'): Promise<ReadableStream>;
+  public async getReadStream(typeArg: 'nodestream'): Promise<plugins.stream.Readable>;
+  public async getReadStream(
+    typeArg: 'nodestream' | 'webstream'
+  ): Promise<ReadableStream | plugins.stream.Readable> {
+    const readStream = this.parentDirectoryRef.bucketRef.fastGetStream(
+      {
+        path: this.getBasePath(),
+      },
+      typeArg as any
+    );
+    return readStream;
+  }
+
+  /**
+   * deletes this file
+   */
+  public async delete(optionsArg?: {
+    mode: 'trash' | 'permanent';
+  }) {
+
+    optionsArg = {
+      ... {
+        mode: 'permanent',
+      },
+      ...optionsArg,
+    }
+
+    if (optionsArg.mode === 'permanent') {
+      await this.parentDirectoryRef.bucketRef.fastRemove({
+        path: this.getBasePath(),
+      });
+      if (!this.name.endsWith('.metadata')) {
+        const metadata = await this.getMetaData();
+        await metadata.metadataFile.delete(optionsArg);
+      }
+    } else if (optionsArg.mode === 'trash') {
+      const metadata = await this.getMetaData();
+      await metadata.storeCustomMetaData({
+        key: 'recycle',
+        value: {
+          deletedAt: Date.now(),
+          originalPath: this.getBasePath(),
+        },
+      });
+      const trash = await this.parentDirectoryRef.bucketRef.getTrash();
+      await this.move({
+        directory: await trash.getTrashDir(),
+        path: await trash.getTrashKeyByOriginalBasePath(this.getBasePath()),
+      });
+    }
+    
+    await this.parentDirectoryRef.listFiles();
+  }
+
+  /**
+   * allows locking the file
+   * @param optionsArg
+   */
+  public async lock(optionsArg?: { timeoutMillis?: number }) {
+    const metadata = await this.getMetaData();
+    await metadata.setLock({
+      lock: 'locked',
+      expires: Date.now() + (optionsArg?.timeoutMillis || 1000),
+    });
+  }
+
+  /**
+   * actively unlocks a file
+   *
+   */
+  public async unlock(optionsArg?: {
+    /**
+     * unlock the file even if not locked from this instance
+     */
+    force?: boolean;
+  }) {
+    const metadata = await this.getMetaData();
+    await metadata.removeLock({
+      force: optionsArg?.force,
+    });
+  }
+
+  public async updateWithContents(optionsArg: {
+    contents: Buffer | string | plugins.stream.Readable | ReadableStream;
+    encoding?: 'utf8' | 'binary';
+  }) {
+    if (
+      optionsArg.contents instanceof plugins.stream.Readable ||
+      optionsArg.contents instanceof ReadableStream
+    ) {
+      await this.parentDirectoryRef.bucketRef.fastPutStream({
+        path: this.getBasePath(),
+        readableStream: optionsArg.contents,
+      });
+    } else if (Buffer.isBuffer(optionsArg.contents)) {
+      await this.parentDirectoryRef.bucketRef.fastPut({
+        path: this.getBasePath(),
+        contents: optionsArg.contents,
+      });
+    } else if (typeof optionsArg.contents === 'string') {
+      await this.parentDirectoryRef.bucketRef.fastPut({
+        path: this.getBasePath(),
+        contents: Buffer.from(optionsArg.contents, optionsArg.encoding),
+      });
+    }
+  }
+
+  /**
+   * moves the file to another directory
+   */
+  public async move(pathDescriptorArg: interfaces.IPathDecriptor) {
+    let moveToPath = '';
+    const isDirectory = await this.parentDirectoryRef.bucketRef.isDirectory(pathDescriptorArg);
+    if (isDirectory) {
+      moveToPath = await helpers.reducePathDescriptorToPath({
+        ...pathDescriptorArg,
+        path: plugins.path.join(pathDescriptorArg.path, this.name),
+      });
+    }
+    // lets move the file
+    await this.parentDirectoryRef.bucketRef.fastMove({
+      sourcePath: this.getBasePath(),
+      destinationPath: moveToPath,
+    });
+
+    // lets move the metadatafile
+    const metadata = await this.getMetaData();
+    await metadata.metadataFile.move(pathDescriptorArg);
+  }
+
+  /**
+   * allows updating the metadata of a file
+   * @param updatedMetadata
+   */
+  public async getMetaData() {
+    if (this.name.endsWith('.metadata')) {
+      throw new Error('metadata files cannot have metadata');
+    }
+    const metadata = await MetaData.createForFile({
+      file: this,
+    });
+    return metadata;
+  }
+
+  /**
+   * gets the contents as json
+   */
+  public async getJsonData() {
+    const json = await this.getContentsAsString();
+    const parsed = await JSON.parse(json);
+    return parsed;
+  }
+
+  public async writeJsonData(dataArg: any) {
+    await this.updateWithContents({
+      contents: JSON.stringify(dataArg),
+    });
+  }
+}

ts/classes.metadata.ts

@@ -0,0 +1,100 @@
+import * as plugins from './plugins.js';
+
+import { File } from './classes.file.js';
+
+export class MetaData {
+  // static
+  public static async createForFile(optionsArg: { file: File }) {
+    const metaData = new MetaData();
+    metaData.fileRef = optionsArg.file;
+
+    // lets find the existing metadata file
+    metaData.metadataFile = await metaData.fileRef.parentDirectoryRef.getFile({
+      name: metaData.fileRef.name + '.metadata',
+      createWithContents: '{}',
+    });
+
+    return metaData;
+  }
+
+  // instance
+  /**
+   * the file that contains the metadata
+   */
+  metadataFile: File;
+
+  /**
+   * the file that the metadata is for
+   */
+  fileRef: File;
+
+  public async getFileType(optionsArg?: {
+    useFileExtension?: boolean;
+    useMagicBytes?: boolean;
+  }): Promise<string> {
+    if ((optionsArg && optionsArg.useFileExtension) || optionsArg.useFileExtension === undefined) {
+      return plugins.path.extname(this.fileRef.name);
+    }
+  }
+
+  /**
+   * gets the size of the fileRef
+   */
+  public async getSizeInBytes(): Promise<number> {
+    const stat = await this.fileRef.parentDirectoryRef.bucketRef.fastStat({
+      path: this.fileRef.getBasePath(),
+    });
+    return stat.ContentLength;
+  }
+
+  private prefixCustomMetaData = 'custom_';
+
+  public async storeCustomMetaData<T = any>(optionsArg: { key: string; value: T }) {
+    const data = await this.metadataFile.getContentsAsString();
+    data[this.prefixCustomMetaData + optionsArg.key] = optionsArg.value;
+    await this.metadataFile.writeJsonData(data);
+  }
+
+  public async getCustomMetaData<T = any>(optionsArg: { key: string }): Promise<T> {
+    const data = await this.metadataFile.getJsonData();
+    return data[this.prefixCustomMetaData + optionsArg.key];
+  }
+
+  public async deleteCustomMetaData(optionsArg: { key: string }) {
+    const data = await this.metadataFile.getJsonData();
+    delete data[this.prefixCustomMetaData + optionsArg.key];
+    await this.metadataFile.writeJsonData(data);
+  }
+
+  /**
+   * set a lock on the ref file
+   * @param optionsArg
+   */
+  public async setLock(optionsArg: { lock: string; expires: number }) {
+    const data = await this.metadataFile.getJsonData();
+    data.lock = optionsArg.lock;
+    data.lockExpires = optionsArg.expires;
+    await this.metadataFile.writeJsonData(data);
+  }
+
+  /**
+   * remove the lock on the ref file
+   * @param optionsArg
+   */
+  public async removeLock(optionsArg: { force: boolean }) {
+    const data = await this.metadataFile.getJsonData();
+    delete data.lock;
+    delete data.lockExpires;
+    await this.metadataFile.writeJsonData(data);
+  }
+
+  public async checkLocked(): Promise<boolean> {
+    const data = await this.metadataFile.getJsonData();
+    return data.lock && data.lockExpires > Date.now();
+  }
+
+  public async getLockInfo(): Promise<{ lock: string; expires: number }> {
+    const data = await this.metadataFile.getJsonData();
+    return { lock: data.lock, expires: data.lockExpires };
+  }
+}

ts/classes.smartbucket.ts

@@ -0,0 +1,47 @@
+// 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 s3Client: plugins.s3.S3Client;
+
+  /**
+   * the constructor of SmartBucket
+   */
+  /**
+   * the constructor of SmartBucket
+   */
+  constructor(configArg: plugins.tsclass.storage.IS3Descriptor) {
+    this.config = configArg;
+
+    const protocol = configArg.useSsl === false ? 'http' : 'https';
+    const port = configArg.port ? `:${configArg.port}` : '';
+    const endpoint = `${protocol}://${configArg.endpoint}${port}`;
+
+    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
+    });
+  }
+
+  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/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/helpers.ts

@@ -0,0 +1,22 @@
+import * as plugins from './plugins.js';
+import * as interfaces from './interfaces.js';
+
+export const reducePathDescriptorToPath = async (pathDescriptorArg: interfaces.IPathDecriptor): Promise<string> => {
+  let returnPath = ``
+  if (pathDescriptorArg.directory) {
+    if (pathDescriptorArg.path && plugins.path.isAbsolute(pathDescriptorArg.path)) {
+      console.warn('Directory is being ignored when path is absolute.');
+      returnPath = pathDescriptorArg.path;
+    } else if (pathDescriptorArg.path) {
+      returnPath = plugins.path.join(pathDescriptorArg.directory.getBasePath(), pathDescriptorArg.path);
+    }
+  } else if (pathDescriptorArg.path) {
+    returnPath = pathDescriptorArg.path;
+  } else {
+    throw new Error('You must specify either a path or a directory.');
+  }
+  if (returnPath.startsWith('/')) {
+    returnPath = returnPath.substring(1);
+  }
+  return returnPath;
+}

ts/index.ts

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

ts/interfaces.ts

@@ -0,0 +1,6 @@
+import type { Directory } from "./classes.directory.js";
+
+export interface IPathDecriptor {
+  path?: string;
+  directory?: Directory;
+}

ts/plugins.ts

@@ -1,3 +1,5 @@
+// plugins.ts
+
 // node native
 import * as path from 'path';
 import * as stream from 'stream';
@@ -5,12 +7,15 @@ import * as stream from 'stream';
 export { path, stream };
 
 // @push.rocks scope
+import * as smartmime from '@push.rocks/smartmime';
 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 { smartpath, smartpromise, smartrx, smartstream };
+export { smartmime, smartpath, smartpromise, smartrx, smartstream, smartstring, smartunique };
 
 // @tsclass
 import * as tsclass from '@tsclass/tsclass';
@@ -20,6 +25,8 @@ export {
 }
 
 // third party scope
-import * as minio from 'minio';
+import * as s3 from '@aws-sdk/client-s3';
 
-export { minio };
+export {
+  s3,
+}

ts/smartbucket.classes.bucket.ts

@@ -1,218 +0,0 @@
-import * as plugins from './smartbucket.plugins.js';
-import { SmartBucket } from './smartbucket.classes.smartbucket.js';
-import { Directory } from './smartbucket.classes.directory.js';
-
-export class Bucket {
-  public static async getBucketByName(smartbucketRef: SmartBucket, bucketNameArg: string) {
-    const buckets = await smartbucketRef.minioClient.listBuckets();
-    const foundBucket = buckets.find((bucket) => {
-      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 fastPut(optionsArg: {
-    path: string;
-    contents: string | Buffer;
-  }): Promise<void> {
-    const streamIntake = new plugins.smartstream.StreamIntake();
-    const putPromise = this.smartbucketRef.minioClient
-      .putObject(this.name, optionsArg.path, streamIntake)
-      .catch((e) => console.log(e));
-    streamIntake.pushData(optionsArg.contents);
-    streamIntake.signalEnd();
-    const response = await putPromise;
-  }
-
-  /**
-   * get file
-   */
-  public async fastGet(optionsArg: Parameters<typeof this.fastGetStream>[0]): Promise<Buffer> {
-    const done = plugins.smartpromise.defer();
-    let completeFile: Buffer;
-    const replaySubject = await this.fastGetStream(optionsArg);
-    const subscription = replaySubject.subscribe({
-      next: (chunk) => {
-        if (completeFile) {
-          completeFile = Buffer.concat([completeFile, chunk]);
-        } else {
-          completeFile = chunk;
-        }
-      },
-      complete: () => {
-        done.resolve();
-        subscription.unsubscribe();
-      },
-      error: (err) => {
-        console.log(err);
-      },
-    });
-    await done.promise;
-    return completeFile;
-  }
-
-  public async fastGetStream(optionsArg: {
-    path: string;
-  }): Promise<plugins.smartrx.rxjs.ReplaySubject<Buffer>> {
-    const fileStream = await this.smartbucketRef.minioClient
-      .getObject(this.name, optionsArg.path)
-      .catch((e) => console.log(e));
-    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;
-      }
-    });
-
-    if (!fileStream) {
-      return null;
-    }
-
-    const smartstream = new plugins.smartstream.StreamWrapper([
-      fileStream,
-      duplexStream,
-    ]);
-    smartstream.run();
-    return replaySubject;
-  }
-
-  /**
-   * store file as stream
-   */
-  public async fastPutStream(optionsArg: {
-    path: string;
-    dataStream: plugins.stream.Readable;
-    nativeMetadata?: { [key: string]: string };
-  }): Promise<void> {
-    await this.smartbucketRef.minioClient.putObject(
-      this.name,
-      optionsArg.path,
-      optionsArg.dataStream,
-      null,
-      ...(optionsArg.nativeMetadata
-        ? (() => {
-            const returnObject: any = {};
-            return returnObject;
-          })()
-        : {})
-    );
-  }
-
-  public async copyObject(optionsArg: {
-    /**
-     * the
-     */
-    objectKey: string;
-    /**
-     * in case you want to copy to another bucket specify it here
-     */
-    targetBucket?: Bucket;
-    targetBucketKey?: string;
-    /**
-     * metadata will be merged with existing metadata
-     */
-    nativeMetadata?: { [key: string]: string };
-    deleteExistingNativeMetadata?: boolean;
-  }): Promise<void> {
-    try {
-      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(
-        targetBucketName,
-        optionsArg.objectKey
-      );
-
-      // Setting up copy conditions
-      const copyConditions = new plugins.minio.CopyConditions();
-
-      // Prepare new metadata
-      const newNativeMetadata = {
-        ...(optionsArg.deleteExistingNativeMetadata ? {} : currentObjInfo.metaData),
-        ...optionsArg.nativeMetadata,
-      };
-
-      // Define the copy operation as a Promise
-      // TODO: check on issue here: https://github.com/minio/minio-js/issues/1286
-      await this.smartbucketRef.minioClient.copyObject(
-        this.name,
-        optionsArg.objectKey,
-        `/${targetBucketName}/${optionsArg.objectKey}`,
-        copyConditions
-      );
-    } catch (err) {
-      console.error('Error updating metadata:', err);
-      throw err; // rethrow to allow caller to handle
-    }
-  }
-
-  /**
-   * removeObject
-   */
-  public async fastRemove(optionsArg: {
-    path: string;
-  }) {
-    await this.smartbucketRef.minioClient.removeObject(this.name, optionsArg.path);
-  }
-
-  public async doesObjectExist(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}'.`);
-      return true;
-    } catch (error) {
-      if (error.code === 'NotFound') {
-        console.log(`Object '${optionsArg.path}' does not exist in bucket '${this.name}'.`);
-        return false;
-      } else {
-        console.error('Error checking object existence:', error);
-        throw error; // Rethrow if it's not a NotFound error to handle unexpected issues
-      }
-    }
-  }
-}

ts/smartbucket.classes.directory.ts

@@ -1,248 +0,0 @@
-import * as plugins from './smartbucket.plugins.js';
-import { Bucket } from './smartbucket.classes.bucket.js';
-import { File } from './smartbucket.classes.file.js';
-
-export class Directory {
-  public bucketRef: Bucket;
-  public parentDirectoryRef: Directory;
-  public name: string;
-
-  public tree: string[];
-  public files: string[];
-  public folders: string[];
-
-  constructor(bucketRefArg: Bucket, parentDiretory: Directory, name: string) {
-    this.bucketRef = bucketRefArg;
-    this.parentDirectoryRef = parentDiretory;
-    this.name = name;
-  }
-
-  /**
-   * returns an array of parent directories
-   */
-  public getParentDirectories(): Directory[] {
-    let parentDirectories: Directory[] = [];
-    if (this.parentDirectoryRef) {
-      parentDirectories.push(this.parentDirectoryRef);
-      parentDirectories = parentDirectories.concat(this.parentDirectoryRef.getParentDirectories());
-    }
-    return parentDirectories;
-  }
-
-  /**
-   * returns the directory level
-   */
-  public getDirectoryLevel(): number {
-    return this.getParentDirectories().length;
-  }
-
-  /**
-   * updates the base path
-   */
-  public getBasePath(): string {
-    const parentDirectories = this.getParentDirectories();
-    let basePath = '';
-    for (const parentDir of parentDirectories) {
-      if (!parentDir.name && !basePath) {
-        basePath = this.name + '/';
-        continue;
-      }
-      if (parentDir.name && !basePath) {
-        basePath = parentDir.name + '/' + this.name + '/';
-        continue;
-      }
-      if (parentDir.name && basePath) {
-        basePath = parentDir.name + '/' + basePath;
-        continue;
-      }
-    }
-    return basePath;
-  }
-
-  /**
-   * lists all files
-   */
-  public async listFiles(): Promise<File[]> {
-    const done = plugins.smartpromise.defer();
-    const fileNameStream = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
-      this.bucketRef.name,
-      this.getBasePath(),
-      false
-    );
-    const fileArray: File[] = [];
-    const duplexStream = new plugins.smartstream.SmartDuplex<plugins.minio.BucketItem, void>({
-      objectMode: true,
-      writeFunction: async (bucketItem) => {
-        if (bucketItem.prefix) {
-          return;
-        }
-        if (!bucketItem.name) {
-          return;
-        }
-        let subtractedPath = bucketItem.name.replace(this.getBasePath(), '');
-        if (subtractedPath.startsWith('/')) {
-          subtractedPath = subtractedPath.substr(1);
-        }
-        if (!subtractedPath.includes('/')) {
-          fileArray.push(
-            new File({
-              directoryRefArg: this,
-              fileName: subtractedPath,
-            })
-          );
-        }
-      },
-      finalFunction: async (tools) => {
-        done.resolve();
-      }
-    });
-    fileNameStream.pipe(duplexStream);
-    await done.promise;
-    return fileArray;
-  }
-
-  /**
-   * lists all folders
-   */
-  public async listDirectories(): Promise<Directory[]> {
-    const done = plugins.smartpromise.defer();
-    const basePath = this.getBasePath();
-    const completeDirStream = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
-      this.bucketRef.name,
-      this.getBasePath(),
-      false
-    );
-    const directoryArray: Directory[] = [];
-    const duplexStream = new plugins.smartstream.SmartDuplex<plugins.minio.BucketItem, void>({
-      objectMode: true,
-      writeFunction: async (bucketItem) => {
-        if (bucketItem.name) {
-          return;
-        }
-        let subtractedPath = bucketItem.prefix.replace(this.getBasePath(), '');
-        if (subtractedPath.startsWith('/')) {
-          subtractedPath = subtractedPath.substr(1);
-        }
-        if (subtractedPath.includes('/')) {
-          const dirName = subtractedPath.split('/')[0];
-          if (directoryArray.find((directory) => directory.name === dirName)) {
-            return;
-          }
-          directoryArray.push(new Directory(this.bucketRef, this, dirName));
-        }
-      },
-      finalFunction: async (tools) => {
-        done.resolve();
-      }
-    });
-    completeDirStream.pipe(duplexStream);
-    await done.promise;
-    return directoryArray;
-  }
-
-  /**
-   * gets an array that has all objects with a certain prefix;
-   */
-  public async getTreeArray() {
-    const treeArray = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2(
-      this.bucketRef.name,
-      this.getBasePath(),
-      true
-    );
-  }
-
-  /**
-   * gets a sub directory
-   */
-  public async getSubDirectoryByName(dirNameArg: string): Promise<Directory> {
-    const dirNameArray = dirNameArg.split('/');
-
-    const getDirectory = async (directoryArg: Directory, dirNameToSearch: string) => {
-      const directories = await directoryArg.listDirectories();
-      return directories.find((directory) => {
-        return directory.name === dirNameToSearch;
-      });
-    };
-    let wantedDirectory: Directory;
-    for (const dirNameToSearch of dirNameArray) {
-      const directoryToSearchIn = wantedDirectory ? wantedDirectory : this;
-      wantedDirectory = await getDirectory(directoryToSearchIn, dirNameToSearch);
-    }
-    return wantedDirectory;
-  }
-
-  /**
-   * moves the directory
-   */
-  public async move() {
-    // TODO
-    throw new Error('moving a directory is not yet implemented');
-  }
-
-  /**
-   * creates a file within this directory
-   * @param relativePathArg
-   */
-  public async createEmptyFile(relativePathArg: string) {
-    const emtpyFile = await File.create({
-      directory: this,
-      name: relativePathArg,
-      contents: '',
-    });
-  }
-
-  // file operations
-  public async fastPut(optionsArg: { path: string; contents: string | Buffer }) {
-    const path = plugins.path.join(this.getBasePath(), optionsArg.path);
-    await this.bucketRef.fastPut({
-      path,
-      contents: optionsArg.contents,
-    });
-  }
-
-  public async fastGet(optionsArg: { path: string }) {
-    const path = plugins.path.join(this.getBasePath(), optionsArg.path);
-    const result = await this.bucketRef.fastGet({
-      path,
-    });
-    return result;
-  }
-
-  public async fastGetStream(pathArg: string): Promise<plugins.smartrx.rxjs.ReplaySubject<Buffer>> {
-    const path = plugins.path.join(this.getBasePath(), pathArg);
-    const result = await this.bucketRef.fastGetStream({
-      path,
-    });
-    return result;
-  }
-
-  public async fastRemove(optionsArg: { path: string }) {
-    const path = plugins.path.join(this.getBasePath(), optionsArg.path);
-    await this.bucketRef.fastRemove({
-      path,
-    });
-  }
-
-  /**
-   * deletes the directory with all its contents
-   */
-  public async delete() {
-    const deleteDirectory = async (directoryArg: Directory) => {
-      const childDirectories = await directoryArg.listDirectories();
-      if (childDirectories.length === 0) {
-        console.log('directory empty! Path complete!');
-      } else {
-        for (const childDir of childDirectories) {
-          await deleteDirectory(childDir);
-        }
-      }
-      const files = await directoryArg.listFiles();
-      for (const file of files) {
-        await directoryArg.fastRemove({
-          path: file.name,
-        });
-      }
-    };
-    await deleteDirectory(this);
-  }
-}

ts/smartbucket.classes.file.ts

@@ -1,140 +0,0 @@
-import * as plugins from './smartbucket.plugins.js';
-import { Directory } from './smartbucket.classes.directory.js';
-
-export interface IFileMetaData {
-  name: string;
-  fileType: string;
-  size: string;
-}
-
-/**
- * represents a file in a directory
- */
-export class File {
-  // STATIC
-
-  /**
-   * creates a file in draft mode
-   * you need to call .save() to store it in s3
-   * @param optionsArg
-   */
-  public static async create(optionsArg: {
-    directory: Directory;
-    name: string;
-    contents: Buffer | string | plugins.stream.Readable;
-    /**
-     * if contents are of type string, you can specify the encoding here
-     */
-    encoding?: 'utf8' | 'binary';
-  }): Promise<File> {
-    const contents =
-      typeof optionsArg.contents === 'string'
-        ? Buffer.from(optionsArg.contents, optionsArg.encoding)
-        : optionsArg.contents;
-    const file = new File({
-      directoryRefArg: optionsArg.directory,
-      fileName: optionsArg.name,
-    });
-    if (contents instanceof plugins.stream.Readable) {} else {
-      await optionsArg.directory.fastPut({
-        path: optionsArg.name,
-        contents: contents,
-      });
-    }
-    return file;
-  }
-
-  // INSTANCE
-  public parentDirectoryRef: Directory;
-  public name: string;
-
-  public path: string;
-  public metaData: IFileMetaData;
-
-  constructor(optionsArg: { directoryRefArg: Directory; fileName: string }) {
-    this.parentDirectoryRef = optionsArg.directoryRefArg;
-    this.name = optionsArg.fileName;
-  }
-
-  public async getContentAsString() {
-    const fileBuffer = await this.getContentAsBuffer();
-    return fileBuffer.toString();
-  }
-
-  public async getContentAsBuffer() {
-    const done = plugins.smartpromise.defer();
-    const fileStream = await this.parentDirectoryRef.bucketRef.smartbucketRef.minioClient
-      .getObject(this.parentDirectoryRef.bucketRef.name, this.path)
-      .catch((e) => console.log(e));
-    let completeFile = Buffer.from('');
-    const duplexStream = new plugins.smartstream.SmartDuplex<Buffer, Buffer>(
-      {
-        writeFunction: async (chunk) => {
-          completeFile = Buffer.concat([chunk]);
-          return chunk;
-        },
-        finalFunction: async (cb) => {
-          done.resolve();
-          return Buffer.from('');
-        },
-      }
-    );
-
-    if (!fileStream) {
-      return null;
-    }
-
-    fileStream.pipe(duplexStream);
-    await done.promise;
-    return completeFile;
-  }
-
-  public async readStreaming() {
-    // TODO
-    throw new Error('not yet implemented');
-  }
-
-  /**
-   * removes this file
-   */
-  public async remove() {
-    await this.parentDirectoryRef.bucketRef.smartbucketRef.minioClient.removeObject(
-      this.parentDirectoryRef.bucketRef.name,
-      this.path
-    );
-    await this.parentDirectoryRef.listFiles();
-  }
-
-  /**
-   * deletes the file
-   */
-  public async delete() {}
-
-  /**
-   * allows locking the file
-   * @param optionsArg
-   */
-  public async lock(optionsArg?: { timeoutMillis?: number }) {}
-
-  /**
-   * actively unlocks a file
-   *
-   */
-  public async unlock(optionsArg?: {
-    /**
-     * unlock the file even if not locked from this instance
-     */
-    force?: boolean;
-  }) {}
-
-  public async updateWithContents(optionsArg: {
-    contents: Buffer | string | plugins.stream.Readable;
-    encoding?: 'utf8' | 'binary';
-  }) {}
-
-  /**
-   * allows updating the metadata of a file
-   * @param updatedMetadata
-   */
-  public async updateMetaData(updatedMetadata: any) {}
-}

ts/smartbucket.classes.smartbucket.ts

@@ -1,35 +0,0 @@
-import * as plugins from './smartbucket.plugins.js';
-import { Bucket } from './smartbucket.classes.bucket.js';
-
-export class SmartBucket {
-  public config: plugins.tsclass.storage.IS3Descriptor;
-
-  public minioClient: plugins.minio.Client;
-
-  /**
-   * the constructor of SmartBucket
-   */
-  constructor(configArg: plugins.tsclass.storage.IS3Descriptor) {
-    this.config = configArg;
-    this.minioClient = new plugins.minio.Client({
-      endPoint: this.config.endpoint,
-      port: configArg.port || 443,
-      useSSL: configArg.useSsl !== undefined ? configArg.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);
-  }
-}