changelog.md

@@ -1,37 +1,5 @@
 # Changelog
 
-## 2024-12-02 - 3.3.7 - fix(package)
-Update author field in package.json
-
-- Corrected the author field from 'Lossless GmbH' to 'Task Venture Capital GmbH' in the package.json file.
-
-## 2024-12-02 - 3.3.6 - fix(package)
-Fix license field in package.json to reflect MIT licensing
-
-
-## 2024-11-25 - 3.3.5 - fix(test)
-Refactor trash test to improve metadata validation
-
-- Added new checks in trash tests to ensure metadata files are correctly moved to trash.
-- Validated the presence and integrity of metadata within trashed files.
-
-## 2024-11-25 - 3.3.4 - fix(core)
-Minor refactoring and cleanup of TypeScript source files for improved readability and maintainability.
-
-
-## 2024-11-24 - 3.3.3 - fix(documentation)
-Improved documentation accuracy and consistency
-
-- Updated the project description to reflect the cloud-agnostic nature and advanced capabilities
-- Enhanced the README with detailed explanations and code examples for advanced features like trash management
-- Clarified the handling and importance of metadata using the MetaData utility
-
-## 2024-11-24 - 3.3.2 - fix(documentation)
-Updated keywords and description for clarity and consistency.
-
-- Modified keywords and description in package.json and npmextra.json.
-- Enhanced readme.md file structure and examples
-
 ## 2024-11-24 - 3.3.1 - fix(File)
 Fixed issue with file restore metadata operations.
 

license

@@ -1,19 +0,0 @@
-Copyright (c) 2014 Task Venture Capital GmbH (hello@task.vc)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

npmextra.json

@@ -8,30 +8,28 @@
       "githost": "code.foss.global",
       "gitscope": "push.rocks",
       "gitrepo": "smartbucket",
-      "description": "A TypeScript library providing a cloud-agnostic interface for managing object storage with functionalities like bucket management, file and directory operations, and advanced features such as metadata handling and file locking.",
+      "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 agnostic",
+        "cloud storage",
         "object storage",
-        "bucket management",
+        "bucket creation",
-        "file operations",
+        "file management",
         "directory management",
         "data streaming",
-        "S3",
         "multi-cloud",
-        "file locking",
+        "API",
-        "metadata management",
-        "buffer handling",
-        "access control",
-        "environment configuration",
         "unified storage",
-        "bucket policies",
+        "S3",
-        "trash management",
+        "minio",
-        "file transfer",
+        "file locking",
-        "data management",
+        "metadata",
-        "streaming"
+        "buffer handling",
+        "access key",
+        "secret key",
+        "cloud agnostic"
       ]
     }
   },

package-lock.json

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

package.json

@@ -1,12 +1,12 @@
 {
   "name": "@push.rocks/smartbucket",
-  "version": "3.3.7",
+  "version": "3.3.1",
-  "description": "A TypeScript library providing a cloud-agnostic interface for managing object storage with functionalities like bucket management, file and directory operations, and advanced features such as metadata handling and file locking.",
+  "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",
-  "author": "Task Venture Capital GmbH",
+  "author": "Lossless GmbH",
-  "license": "MIT",
+  "license": "UNLICENSED",
   "scripts": {
     "test": "(tstest test/)",
     "build": "(tsbuild --web --allowimplicitany)"
@@ -47,25 +47,23 @@
   ],
   "keywords": [
     "TypeScript",
-    "cloud agnostic",
+    "cloud storage",
     "object storage",
-    "bucket management",
+    "bucket creation",
-    "file operations",
+    "file management",
     "directory management",
     "data streaming",
-    "S3",
     "multi-cloud",
-    "file locking",
+    "API",
-    "metadata management",
-    "buffer handling",
-    "access control",
-    "environment configuration",
     "unified storage",
-    "bucket policies",
+    "S3",
-    "trash management",
+    "minio",
-    "file transfer",
+    "file locking",
-    "data management",
+    "metadata",
-    "streaming"
+    "buffer handling",
+    "access key",
+    "secret key",
+    "cloud agnostic"
   ],
   "homepage": "https://code.foss.global/push.rocks/smartbucket",
   "repository": {

readme.hints.md

@@ -1,3 +1 @@
-* The project uses the official s3 client, not the minio client.
+ 
-* notice the difference between *Strict methods and the normal methods.
-* metadata is handled though the MetaData class. Important!

readme.md

@@ -1,49 +1,41 @@
-```markdown
 # @push.rocks/smartbucket
 
-A comprehensive TypeScript library for cloud-agnostic object storage offering bucket management, file operations, and advanced data streaming.
+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`, ensure you have Node.js and npm installed. Then, run the following command in your project 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
 ```
 
-This command will add `@push.rocks/smartbucket` to your project's dependencies and install it along with its requirements in the `node_modules` directory.
+This command will download and install `@push.rocks/smartbucket` along with its required dependencies into your project's `node_modules` directory and save it as a dependency in your project's `package.json` file.
 
 ## Usage
 
-### Introduction
+`@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` provides a robust set of features to manage cloud storage operations in a cloud-agnostic manner. By leveraging this library, you can seamlessly interact with object storage services like AWS S3, without being tied to any vendor-specific implementations. This library not only abstracts basic file operations but also integrates advanced capabilities such as metadata management, data streaming, file locking, and bucket policies, all through a simplified API.
+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.
 
 ### Table of Contents
-
 1. [Setting Up](#setting-up)
-2. [Working with Buckets](#working-with-buckets)
+2. [Creating a New Bucket](#creating-a-new-bucket)
-    - [Creating a New Bucket](#creating-a-new-bucket)
+3. [Listing Buckets](#listing-buckets)
-    - [Listing Buckets](#listing-buckets)
+4. [Working with Files](#working-with-files)
-    - [Deleting Buckets](#deleting-buckets)
-3. [File Operations in Buckets](#file-operations-in-buckets)
     - [Uploading Files](#uploading-files)
     - [Downloading Files](#downloading-files)
-    - [Streaming Files](#streaming-files)
     - [Deleting Files](#deleting-files)
-4. [Directory Operations](#directory-operations)
+    - [Streaming Files](#streaming-files)
-    - [Listing Directories and Files](#listing-directories-and-files)
+5. [Working with Directories](#working-with-directories)
-    - [Managing Files in Directories](#managing-files-in-directories)
+6. [Advanced Features](#advanced-features)
-5. [Advanced Features](#advanced-features)
     - [Bucket Policies](#bucket-policies)
-    - [Metadata Management](#metadata-management)
+    - [Object Metadata](#object-metadata)
-    - [File Locking](#file-locking)
+    - [Cloud Agnostic](#cloud-agnostic)
-    - [Trash Management](#trash-management)
-6. [Cloud Agnosticism](#cloud-agnosticism)
 
 ### Setting Up
 
-Begin by importing the necessary classes from the `@push.rocks/smartbucket` package into your TypeScript file. Create an instance of `SmartBucket` with your storage configuration:
+First, ensure you are using ECMAScript modules (ESM) and TypeScript in your project for best compatibility. Here's how to import and initialize SmartBucket in a TypeScript file:
 
 ```typescript
 import {
@@ -57,223 +49,264 @@ const mySmartBucket = new SmartBucket({
   accessKey: "yourAccessKey",
   accessSecret: "yourSecretKey",
   endpoint: "yourEndpointURL",
-  port: 443,
+  port: 443,            // Default is 443, can be customized for specific endpoint
-  useSsl: true
+  useSsl: true          // Defaults to true
 });
 ```
 
-Replace `"yourAccessKey"`, `"yourSecretKey"`, and `"yourEndpointURL"` with actual data specific to your cloud provider.
+Make sure to replace `"yourAccessKey"`, `"yourSecretKey"`, and `"yourEndpointURL"` with your actual credentials and endpoint URL. The `port` and `useSsl` options are optional and can be omitted if the defaults are acceptable.
 
-### Working with Buckets
+### Creating a New Bucket
 
-#### Creating a New Bucket
+To create a new bucket:
-
-Creating a bucket involves invoking the `createBucket` method. Note that bucket names are unique and follow the rules of the cloud provider:
 
 ```typescript
 async function createBucket(bucketName: string) {
   try {
-    const newBucket: Bucket = await mySmartBucket.createBucket(bucketName);
+    const myBucket: Bucket = await mySmartBucket.createBucket(bucketName);
     console.log(`Bucket ${bucketName} created successfully.`);
   } catch (error) {
     console.error("Error creating bucket:", error);
   }
 }
 
-createBucket("myNewBucket");
+// Use the function
+createBucket("exampleBucket");
 ```
 
-#### Listing Buckets
+Bucket names must be unique across the storage service.
 
-While the library uses cloud-provider capabilities like AWS SDK to list existing buckets, `smartbucket` is aimed at simplifying content management within them.
+### Listing Buckets
 
-#### Deleting Buckets
+Currently, SmartBucket does not include a direct method to list all buckets, but you can access the underlying client provided by the cloud storage SDK to perform such operations, depending on the SDK's capabilities.
 
-To delete a bucket, simply call the `removeBucket` function:
+### Working with Files
-
-```typescript
-async function deleteBucket(bucketName: string) {
-  try {
-    await mySmartBucket.removeBucket(bucketName);
-    console.log(`Bucket ${bucketName} deleted successfully.`);
-  } catch (error) {
-    console.error("Error deleting bucket:", error);
-  }
-}
-
-deleteBucket("anotherBucketName");
-```
-
-### File Operations in Buckets
-
-SmartBucket offers a unified API to execute file-based operations efficiently.
 
 #### Uploading Files
 
-Upload a file using the `fastPut` method, specifying the bucket name, file path, and content:
+To upload an object to a bucket:
 
 ```typescript
 async function uploadFile(bucketName: string, filePath: string, fileContent: Buffer | string) {
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  await bucket.fastPut({ path: filePath, contents: fileContent });
+  if (myBucket) {
-  console.log(`File uploaded to ${filePath}`);
+    await myBucket.fastPut({ path: filePath, contents: fileContent });
+    console.log(`File uploaded to ${bucketName} at ${filePath}`);
+  } else {
+    console.error(`Bucket ${bucketName} does not exist.`);
+  }
 }
 
-uploadFile("myBucket", "example.txt", "This is a sample file content.");
+// Use the function
+uploadFile("exampleBucket", "path/to/object.txt", "Hello, world!");
 ```
 
 #### Downloading Files
 
-Download files using `fastGet`. It retrieves the file content as a buffer:
+To download an object:
 
 ```typescript
 async function downloadFile(bucketName: string, filePath: string) {
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  const content: Buffer = await bucket.fastGet({ path: filePath });
+  if (myBucket) {
-  console.log("Downloaded content:", content.toString());
+    const fileContent: Buffer = await myBucket.fastGet({ path: filePath });
+    console.log("Downloaded file content:", fileContent.toString());
+  } else {
+    console.error(`Bucket ${bucketName} does not exist.`);
+  }
 }
 
-downloadFile("myBucket", "example.txt");
+// Use the function
-```
+downloadFile("exampleBucket", "path/to/object.txt");
-
-#### Streaming Files
-
-For large-scale applications, stream files without loading them fully into memory:
-
-```typescript
-async function streamFile(bucketName: string, filePath: string) {
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  const stream = await bucket.fastGetStream({ path: filePath }, "nodestream");
-  stream.on('data', chunk => console.log("Chunk:", chunk.toString()));
-  stream.on('end', () => console.log("Download completed."));
-}
-
-streamFile("myBucket", "largefile.txt");
 ```
 
 #### Deleting Files
 
-Delete files with precision using `fastRemove`:
+To delete an object from a bucket:
 
 ```typescript
 async function deleteFile(bucketName: string, filePath: string) {
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  await bucket.fastRemove({ path: filePath });
+  if (myBucket) {
-  console.log(`File ${filePath} deleted.`);
+    await myBucket.fastRemove({ path: filePath });
+    console.log(`File at ${filePath} deleted from ${bucketName}.`);
+  } else {
+    console.error(`Bucket ${bucketName} does not exist.`);
+  }
 }
 
-deleteFile("myBucket", "example.txt");
+// Use the function
+deleteFile("exampleBucket", "path/to/object.txt");
 ```
 
-### Directory Operations
+#### Streaming Files
 
-Leverage directory functionalities to better organize and manage files within buckets.
+SmartBucket allows you to work with file streams, which can be useful for handling large files. 
 
-#### Listing Directories and Files
+To read a file as a stream:
-
-Listing contents showcases a directory’s structure and file contents:
 
 ```typescript
-async function listDirectory(bucketName: string, directoryPath: string) {
+import { ReplaySubject } from '@push.rocks/smartrx';
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  const baseDirectory: Directory = await bucket.getBaseDirectory();
-  const targetDirectory = await baseDirectory.getSubDirectoryByName(directoryPath);
 
-  console.log('Directories:');
+async function readFileStream(bucketName: string, filePath: string) {
-  (await targetDirectory.listDirectories()).forEach(dir => console.log(dir.name));
+  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-
+  if (myBucket) {
-  console.log('Files:');
+    const fileStream: ReplaySubject<Buffer> = await myBucket.fastGetStream({ path: filePath });
-  (await targetDirectory.listFiles()).forEach(file => console.log(file.name));
+    fileStream.subscribe({
+      next(chunk: Buffer) {
+        console.log("Chunk received:", chunk.toString());
+      },
+      complete() {
+        console.log("File read completed.");
+      },
+      error(err) {
+        console.error("Error reading file stream:", err);
+      }
+    });
+  } else {
+    console.error(`Bucket ${bucketName} does not exist.`);
+  }
 }
 
-listDirectory("myBucket", "path/to/directory");
+// Use the function
+readFileStream("exampleBucket", "path/to/object.txt");
 ```
 
-#### Managing Files in Directories
+To write a file as a stream:
-
-Additional functionalities allow file management, inclusive of handling sub-directories:
 
 ```typescript
-async function manageFilesInDirectory(bucketName: string, directoryPath: string, fileName: string, content: string) {
+import { Readable } from 'stream';
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  const baseDirectory: Directory = await bucket.getBaseDirectory();
-  const directory = await baseDirectory.getSubDirectoryByName(directoryPath) ?? baseDirectory;
 
-  await directory.fastPut({ path: fileName, contents: content });
+async function writeFileStream(bucketName: string, filePath: string, readableStream: Readable) {
-  console.log(`File ${fileName} created in ${directoryPath}`);
+  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-
+  if (myBucket) {
-  const fileContent = await directory.fastGet({ path: fileName });
+    await myBucket.fastPutStream({ path: filePath, dataStream: readableStream });
-  console.log(`Content of ${fileName}: ${fileContent.toString()}`);
+    console.log(`File streamed to ${bucketName} at ${filePath}`);
+  } else {
+    console.error(`Bucket ${bucketName} does not exist.`);
+  }
 }
 
-manageFilesInDirectory("myBucket", "myDir", "example.txt", "File content here");
+// Create a readable stream from a string
+const readable = new Readable();
+readable.push('Hello world streamed as a file!');
+readable.push(null); // End of stream
+
+// Use the function
+writeFileStream("exampleBucket", "path/to/streamedObject.txt", readable);
+```
+
+### Working with Directories
+
+`@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) {
+  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  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 => {
+      console.log(`- ${dir.name}`);
+    });
+
+    console.log('Listing files:');
+    const files = await targetDirectory.listFiles();
+    files.forEach(file => {
+      console.log(`- ${file.name}`);
+    });
+  } else {
+    console.error(`Bucket ${bucketName} does not exist.`);
+  }
+}
+
+// Use the function
+listDirectoryContents("exampleBucket", "some/directory/path");
+```
+
+To create a file within a directory:
+
+```typescript
+async function createFileInDirectory(bucketName: string, directoryPath: string, fileName: string, fileContent: string) {
+  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  if (myBucket) {
+    const baseDirectory: Directory = await myBucket.getBaseDirectory();
+    const targetDirectory: Directory = await baseDirectory.getSubDirectoryByName(directoryPath);
+    await targetDirectory.createEmptyFile(fileName); // Create an empty file
+    const file = new File({ directoryRefArg: targetDirectory, fileName });
+    await file.updateWithContents({ contents: fileContent });
+    console.log(`File created: ${fileName}`);
+  } else {
+    console.error(`Bucket ${bucketName} does not exist.`);
+  }
+}
+
+// Use the function
+createFileInDirectory("exampleBucket", "some/directory", "newfile.txt", "Hello, world!");
 ```
 
 ### Advanced Features
 
-The library’s advanced features streamline intricate cloud storage workflows.
-
 #### Bucket Policies
 
-The library offers tools for maintaining consistent bucket policies across storage providers, assisting in defining access roles and permissions.
+Manage bucket policies to control access permissions. This feature depends on the policies provided by the storage service (e.g., AWS S3, MinIO).
 
-#### Metadata Management
+#### Object Metadata
 
-Easily manage and store metadata by using the `MetaData` utility:
+Retrieve and modify object metadata. Metadata can be useful for storing additional information about an object.
+
+To retrieve metadata:
 
 ```typescript
-async function handleMetadata(bucketName: string, filePath: string) {
+async function getObjectMetadata(bucketName: string, filePath: string) {
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  const meta = await bucket.fastStat({ path: filePath });
+  if (myBucket) {
-  console.log("Metadata:", meta.Metadata);
+    const metadata = await mySmartBucket.minioClient.statObject(bucketName, filePath);
+    console.log("Object metadata:", metadata);
+  } else {
+    console.error(`Bucket ${bucketName} does not exist.`);
+  }
 }
 
-handleMetadata("myBucket", "example.txt");
+// Use the function
+getObjectMetadata("exampleBucket", "path/to/object.txt");
 ```
 
-#### File Locking
+To update metadata:
-
-Prevent accidental writes by locking files:
 
 ```typescript
-async function lockFile(bucketName: string, filePath: string) {
+async function updateObjectMetadata(bucketName: string, filePath: string, newMetadata: { [key: string]: string }) {
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  const file: File = await bucket.getBaseDirectory().getFileStrict({ path: filePath });
+  if (myBucket) {
-  await file.lock({ timeoutMillis: 600000 }); // Lock for 10 minutes
+    await myBucket.copyObject({
-  console.log(`File ${filePath} locked.`);
+      objectKey: filePath,
+      nativeMetadata: newMetadata,
+      deleteExistingNativeMetadata: false,
+    });
+    console.log(`Metadata updated for ${filePath}`);
+  } else {
+    console.error(`Bucket ${bucketName} does not exist.`);
+  }
 }
 
-lockFile("myBucket", "example.txt");
+// Use the function
+updateObjectMetadata("exampleBucket", "path/to/object.txt", {
+  customKey: "customValue"
+});
 ```
 
-#### Trash Management
+#### Cloud Agnostic
 
-SmartBucket enables a safe deletion mode where files can be moved to a recycling bin, allowing for restoration:
+`@push.rocks/smartbucket` is designed to work with multiple cloud providers, allowing for easier migration or multi-cloud strategies. This means you can switch from one provider to another with minimal changes to your codebase.
 
-```typescript
+Remember, each cloud provider has specific features and limitations. `@push.rocks/smartbucket` aims to abstract common functionalities, but always refer to the specific cloud provider's documentation for advanced features or limitations.
-async function trashAndRestoreFile(bucketName: string, filePath: string) {
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  const file: File = await bucket.getBaseDirectory().getFileStrict({ path: filePath });
 
-  // Move the file to trash
+This guide covers the basic to advanced scenarios of using `@push.rocks/smartbucket`. For further details, refer to the API documentation and examples.
-  await file.delete({ mode: 'trash' });
-  console.log(`File ${filePath} moved to trash.`);
-
-  // Retrieve the file from the trash
-  const trashFile = await bucket.getTrash().getTrashedFileByOriginalName({ path: filePath });
-  await trashFile.restore();
-  console.log(`File ${filePath} restored from trash.`);
-}
-
-trashAndRestoreFile("myBucket", "example.txt");
-```
-
-### Cloud Agnosticism
-
-`@push.rocks/smartbucket` supports a multitude of cloud providers, enhancing flexibility in adopting different cloud strategies without the need for extensive code rewrite. It offers a uniform interface allowing to perform operations seamlessly between different storage solutions such as AWS S3, Google Cloud Storage, and more. This aspect empowers organizations to align their storage decisions with business needs rather than technical constraints.
-
-By following this guide, you should be well-equipped to handle cloud storage operations using the `@push.rocks/smartbucket` library. Diligently constructed code examples elucidate the extensive functionalities offered by the library, aligned with best practices in cloud storage. For a deeper dive into any specific feature, refer to the comprehensive documentation provided with the library and the official documentation of the cloud providers you are integrating with.
-```
 
 ## License and Legal Information
 

test/test.trash.ts

@@ -52,21 +52,7 @@ tap.test('should put a file into the trash', async () => {
   console.log(fileMetadata.toString());
   expect(await file.getMetaData().then((meta) => meta.metadataFile.getJsonData())).toEqual({});
   await file.delete({ mode: 'trash' });
-
+  jestExpect(await file.getMetaData().then((meta) => meta.metadataFile.getJsonData())).toEqual({
-  const getTrashContents = async () => {
-    const trash = await myBucket.getTrash();
-    const trashDir = await trash.getTrashDir();
-    return await trashDir.listFiles();
-  }
-
-  const trashedFiles = await getTrashContents();
-  expect(trashedFiles.length).toEqual(2);
-
-  const trashedMetaFile = trashedFiles.find(file => file.name.endsWith('.metadata'));
-  expect(trashedMetaFile).toBeDefined();
-  expect(trashedMetaFile).toBeInstanceOf(smartbucket.File);
-
-  jestExpect(await trashedMetaFile!.getJsonData()).toEqual({
     custom_recycle: {
       deletedAt: jestExpect.any(Number),
       originalPath: "trashtest/trashme.txt",

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartbucket',
-  version: '3.3.7',
+  version: '3.3.1',
-  description: 'A TypeScript library providing a cloud-agnostic interface for managing object storage with functionalities like bucket management, file and directory operations, and advanced features such as metadata handling and file locking.'
+  description: 'A TypeScript library offering simple and cloud-agnostic object storage with advanced features like bucket creation, file and directory management, and data streaming.'
 }