3.3.9

.gitlab-ci.yml

@@ -1,140 +0,0 @@
-# gitzone ci_default
-image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-
-cache:
-  paths:
-    - .npmci_cache/
-  key: '$CI_BUILD_STAGE'
-
-stages:
-  - security
-  - test
-  - release
-  - metadata
-
-before_script:
-  - npm install -g @shipzone/npmci
-
-# ====================
-# security stage
-# ====================
-mirror:
-  stage: security
-  script:
-    - npmci git mirror
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-auditProductionDependencies:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install --production --ignore-scripts
-    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=prod --production
-  tags:
-    - docker
-  allow_failure: true
-
-auditDevDependencies:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install --ignore-scripts
-    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=dev
-  tags:
-    - docker
-  allow_failure: true
-
-# ====================
-# test stage
-# ====================
-
-testStable:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - docker
-
-testBuild:
-  stage: test
-  script:
-    - npmci npm prepare
-    - npmci node install stable
-    - npmci npm install
-    - npmci command npm run build
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-    - docker
-
-release:
-  stage: release
-  script:
-    - npmci node install stable
-    - npmci npm publish
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  allow_failure: true
-  only:
-    - tags
-  script:
-    - npmci command npm install -g typescript
-    - npmci npm prepare
-    - npmci npm install
-  tags:
-    - lossless
-    - docker
-    - priv
-
-trigger:
-  stage: metadata
-  script:
-    - npmci trigger
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
-pages:
-  stage: metadata
-  script:
-    - npmci node install lts
-    - npmci command npm install -g @git.zone/tsdoc
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command tsdoc
-  tags:
-    - lossless
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-      - public
-  allow_failure: true

changelog.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 2025-08-15 - 3.3.9 - fix(docs)
+Revise README with detailed usage examples and add local Claude settings
+
+- Revamped README: reorganized content, added emojis and clearer headings for install, getting started, bucket/file/directory operations, streaming, metadata, trash/recovery, locking, and advanced configuration.
+- Added many concrete code examples for SmartBucket, Bucket, Directory, File, streaming (node/web), RxJS replay subjects, metadata handling, trash workflow, file locking, magic-bytes detection, JSON operations, and cleaning bucket contents.
+- Included testing instructions (pnpm test) and a Best Practices section with recommendations for strict mode, streaming, metadata, trash usage, and locking.
+- Added .claude/settings.local.json to include local Claude configuration and tool permissions.
+- No source code or public API changes; documentation and local tooling config only.
+
+## 2025-08-15 - 3.3.8 - fix(tests)
+Update tests to use @git.zone/tstest, upgrade dependencies, remove GitLab CI and add local CI/workspace config
+
+- Tests: replace imports from @push.rocks/tapbundle with @git.zone/tstest/tapbundle and switch tap.start() to export default tap.start()
+- Dependencies: bump @aws-sdk/client-s3 and several @push.rocks packages; upgrade @tsclass/tsclass to a newer major
+- DevDependencies: upgrade @git.zone/tsbuild, @git.zone/tstest, @push.rocks/qenv, and @push.rocks/tapbundle
+- CI/config: remove .gitlab-ci.yml, add .claude/settings.local.json
+- Workspace: add pnpm-workspace.yaml and packageManager field in package.json
+
+## 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
 

package-lock.json

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

package.json

@@ -1,33 +1,33 @@
 {
   "name": "@push.rocks/smartbucket",
-  "version": "3.3.6",
+  "version": "3.3.9",
   "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.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "type": "module",
-  "author": "Lossless GmbH",
+  "author": "Task Venture Capital GmbH",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
     "build": "(tsbuild --web --allowimplicitany)"
   },
   "devDependencies": {
-    "@git.zone/tsbuild": "^2.1.84",
+    "@git.zone/tsbuild": "^2.6.4",
     "@git.zone/tsrun": "^1.2.49",
-    "@git.zone/tstest": "^1.0.90",
+    "@git.zone/tstest": "^2.3.2",
-    "@push.rocks/qenv": "^6.1.0",
+    "@push.rocks/qenv": "^6.1.2",
-    "@push.rocks/tapbundle": "^5.5.3"
+    "@push.rocks/tapbundle": "^6.0.3"
   },
   "dependencies": {
-    "@aws-sdk/client-s3": "^3.699.0",
+    "@aws-sdk/client-s3": "^3.864.0",
     "@push.rocks/smartmime": "^2.0.4",
-    "@push.rocks/smartpath": "^5.0.18",
+    "@push.rocks/smartpath": "^6.0.0",
-    "@push.rocks/smartpromise": "^4.0.4",
+    "@push.rocks/smartpromise": "^4.2.3",
-    "@push.rocks/smartrx": "^3.0.7",
+    "@push.rocks/smartrx": "^3.0.10",
     "@push.rocks/smartstream": "^3.2.5",
     "@push.rocks/smartstring": "^4.0.15",
     "@push.rocks/smartunique": "^3.0.9",
-    "@tsclass/tsclass": "^4.1.2"
+    "@tsclass/tsclass": "^9.2.0"
   },
   "private": false,
   "files": [
@@ -71,5 +71,6 @@
   "repository": {
     "type": "git",
     "url": "https://code.foss.global/push.rocks/smartbucket.git"
-  }
+  },
+  "packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748"
 }

pnpm-workspace.yaml

@@ -0,0 +1,4 @@
+onlyBuiltDependencies:
+  - esbuild
+  - mongodb-memory-server
+  - puppeteer

readme.md

@@ -1,280 +1,457 @@
-```markdown
+# @push.rocks/smartbucket 🪣
-# @push.rocks/smartbucket
 
-A comprehensive TypeScript library for cloud-agnostic object storage offering bucket management, file operations, and advanced data streaming.
+> A powerful, cloud-agnostic TypeScript library for object storage with advanced features like file locking, metadata management, and intelligent trash handling.
 
-## Install
+## 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`, run:
 
 ```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.
+Or if you're using pnpm (recommended):
 
-## Usage
+```bash
+pnpm add @push.rocks/smartbucket
+```
+
+## Usage 🚀
 
 ### Introduction
 
-`@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.
+`@push.rocks/smartbucket` provides a unified, cloud-agnostic API for object storage operations across major providers like AWS S3, Google Cloud Storage, MinIO, and more. It abstracts away provider-specific complexities while offering advanced features like metadata management, file locking, streaming operations, and intelligent trash management.
 
 ### Table of Contents
 
-1. [Setting Up](#setting-up)
+1. [🏁 Getting Started](#-getting-started)
-2. [Working with Buckets](#working-with-buckets)
+2. [🗂️ Working with Buckets](#️-working-with-buckets)
-    - [Creating a New Bucket](#creating-a-new-bucket)
+3. [📁 File Operations](#-file-operations)
-    - [Listing Buckets](#listing-buckets)
+4. [📂 Directory Management](#-directory-management)
-    - [Deleting Buckets](#deleting-buckets)
+5. [🌊 Streaming Operations](#-streaming-operations)
-3. [File Operations in Buckets](#file-operations-in-buckets)
+6. [🔒 File Locking](#-file-locking)
-    - [Uploading Files](#uploading-files)
+7. [🏷️ Metadata Management](#️-metadata-management)
-    - [Downloading Files](#downloading-files)
+8. [🗑️ Trash & Recovery](#️-trash--recovery)
-    - [Streaming Files](#streaming-files)
+9. [⚡ Advanced Features](#-advanced-features)
-    - [Deleting Files](#deleting-files)
+10. [☁️ Cloud Provider Support](#️-cloud-provider-support)
-4. [Directory Operations](#directory-operations)
-    - [Listing Directories and Files](#listing-directories-and-files)
-    - [Managing Files in Directories](#managing-files-in-directories)
-5. [Advanced Features](#advanced-features)
-    - [Bucket Policies](#bucket-policies)
-    - [Metadata Management](#metadata-management)
-    - [File Locking](#file-locking)
-    - [Trash Management](#trash-management)
-6. [Cloud Agnosticism](#cloud-agnosticism)
 
-### Setting Up
+### 🏁 Getting Started
 
-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, set up your storage connection:
 
 ```typescript
-import {
+import { SmartBucket } from '@push.rocks/smartbucket';
-  SmartBucket,
-  Bucket,
-  Directory,
-  File
-} from '@push.rocks/smartbucket';
 
-const mySmartBucket = new SmartBucket({
+// Initialize with your cloud storage credentials
-  accessKey: "yourAccessKey",
+const smartBucket = new SmartBucket({
-  accessSecret: "yourSecretKey",
+  accessKey: 'your-access-key',
-  endpoint: "yourEndpointURL",
+  accessSecret: 'your-secret-key',
+  endpoint: 's3.amazonaws.com', // Or your provider's endpoint
   port: 443,
-  useSsl: true
+  useSsl: true,
+  region: 'us-east-1' // Optional, defaults to 'us-east-1'
 });
 ```
 
-Replace `"yourAccessKey"`, `"yourSecretKey"`, and `"yourEndpointURL"` with actual data specific to your cloud provider.
+### 🗂️ Working with Buckets
 
-### Working with Buckets
+#### Creating Buckets
-
-#### Creating 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) {
+// Create a new bucket
-  try {
+const myBucket = await smartBucket.createBucket('my-awesome-bucket');
-    const newBucket: Bucket = await mySmartBucket.createBucket(bucketName);
+console.log(`✅ Bucket created: ${myBucket.name}`);
-    console.log(`Bucket ${bucketName} created successfully.`);
+```
-  } catch (error) {
+
-    console.error("Error creating bucket:", error);
+#### Getting Existing Buckets
+
+```typescript
+// Get a bucket reference
+const existingBucket = await smartBucket.getBucketByName('existing-bucket');
+
+// Or use strict mode (throws if bucket doesn't exist)
+const bucketStrict = await smartBucket.getBucketByNameStrict('must-exist-bucket');
+```
+
+#### Removing Buckets
+
+```typescript
+// Delete a bucket (must be empty)
+await smartBucket.removeBucket('old-bucket');
+console.log('🗑️ Bucket removed');
+```
+
+### 📁 File Operations
+
+#### Upload Files
+
+```typescript
+const bucket = await smartBucket.getBucketByName('my-bucket');
+
+// Simple file upload
+await bucket.fastPut({
+  path: 'documents/report.pdf',
+  contents: Buffer.from('Your file content here')
+});
+
+// Upload with string content
+await bucket.fastPut({
+  path: 'notes/todo.txt',
+  contents: 'Buy milk\nCall mom\nRule the world'
+});
+
+// Strict upload (returns File object)
+const uploadedFile = await bucket.fastPutStrict({
+  path: 'images/logo.png',
+  contents: imageBuffer,
+  overwrite: true // Optional: control overwrite behavior
+});
+```
+
+#### Download Files
+
+```typescript
+// Get file as Buffer
+const fileContent = await bucket.fastGet({
+  path: 'documents/report.pdf'
+});
+console.log(`📄 File size: ${fileContent.length} bytes`);
+
+// Get file as string
+const textContent = fileContent.toString('utf-8');
+```
+
+#### Check File Existence
+
+```typescript
+const exists = await bucket.fastExists({
+  path: 'documents/report.pdf'
+});
+console.log(`File exists: ${exists ? '✅' : '❌'}`);
+```
+
+#### Delete Files
+
+```typescript
+// Permanent deletion
+await bucket.fastRemove({
+  path: 'old-file.txt'
+});
+```
+
+#### Copy & Move Files
+
+```typescript
+// Copy file within bucket
+await bucket.fastCopy({
+  sourcePath: 'original/file.txt',
+  destinationPath: 'backup/file-copy.txt'
+});
+
+// Move file (copy + delete original)
+await bucket.fastMove({
+  sourcePath: 'temp/draft.txt',
+  destinationPath: 'final/document.txt'
+});
+```
+
+### 📂 Directory Management
+
+SmartBucket provides powerful directory-like operations for organizing your files:
+
+```typescript
+// Get base directory
+const baseDir = await bucket.getBaseDirectory();
+
+// List directories and files
+const directories = await baseDir.listDirectories();
+const files = await baseDir.listFiles();
+
+console.log(`📁 Found ${directories.length} directories`);
+console.log(`📄 Found ${files.length} files`);
+
+// Navigate subdirectories
+const subDir = await baseDir.getSubDirectoryByName('projects/2024');
+
+// Create nested file
+await subDir.fastPut({
+  path: 'report.pdf',
+  contents: reportBuffer
+});
+
+// Get directory tree structure
+const tree = await subDir.getTreeArray();
+console.log('🌳 Directory tree:', tree);
+
+// Create empty file as placeholder
+await subDir.createEmptyFile('placeholder.txt');
+```
+
+### 🌊 Streaming Operations
+
+Handle large files efficiently with streaming:
+
+#### Download Streams
+
+```typescript
+// Node.js stream
+const nodeStream = await bucket.fastGetStream(
+  { path: 'large-video.mp4' },
+  'nodestream'
+);
+nodeStream.pipe(fs.createWriteStream('local-video.mp4'));
+
+// Web stream (for modern environments)
+const webStream = await bucket.fastGetStream(
+  { path: 'large-file.zip' },
+  'webstream'
+);
+```
+
+#### Upload Streams
+
+```typescript
+// Stream upload from file
+const readStream = fs.createReadStream('big-data.csv');
+await bucket.fastPutStream({
+  path: 'uploads/big-data.csv',
+  stream: readStream,
+  metadata: {
+    contentType: 'text/csv',
+    userMetadata: {
+      uploadedBy: 'data-team',
+      version: '2.0'
     }
-}
-
-createBucket("myNewBucket");
-```
-
-#### Listing Buckets
-
-While the library uses cloud-provider capabilities like AWS SDK to list existing buckets, `smartbucket` is aimed at simplifying content management within them.
-
-#### Deleting Buckets
-
-To delete a bucket, simply call the `removeBucket` function:
-
-```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
+#### Reactive Streams with RxJS
-
-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:
 
 ```typescript
-async function uploadFile(bucketName: string, filePath: string, fileContent: Buffer | string) {
+// Get file as ReplaySubject for reactive programming
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+const replaySubject = await bucket.fastGetReplaySubject({
-  await bucket.fastPut({ path: filePath, contents: fileContent });
+  path: 'data/sensor-readings.json',
-  console.log(`File uploaded to ${filePath}`);
+  chunkSize: 1024
-}
+});
 
-uploadFile("myBucket", "example.txt", "This is a sample file content.");
+replaySubject.subscribe({
+  next: (chunk) => processChunk(chunk),
+  complete: () => console.log('✅ Stream complete')
+});
 ```
 
-#### Downloading Files
+### 🔒 File Locking
 
-Download files using `fastGet`. It retrieves the file content as a buffer:
+Prevent accidental modifications with file locking:
 
 ```typescript
-async function downloadFile(bucketName: string, filePath: string) {
+const file = await bucket.getBaseDirectory()
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  .getFileStrict({ path: 'important-config.json' });
-  const content: Buffer = await bucket.fastGet({ path: filePath });
+
-  console.log("Downloaded content:", content.toString());
+// Lock file for 10 minutes
+await file.lock({ timeoutMillis: 600000 });
+console.log('🔒 File locked');
+
+// Try to modify locked file (will throw error)
+try {
+  await file.delete();
+} catch (error) {
+  console.log('❌ Cannot delete locked file');
 }
 
-downloadFile("myBucket", "example.txt");
+// Unlock when done
+await file.unlock();
+console.log('🔓 File unlocked');
 ```
 
-#### Streaming Files
+### 🏷️ Metadata Management
 
-For large-scale applications, stream files without loading them fully into memory:
+Attach and manage metadata for your files:
 
 ```typescript
-async function streamFile(bucketName: string, filePath: string) {
+const file = await bucket.getBaseDirectory()
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  .getFileStrict({ path: 'document.pdf' });
-  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");
+// Get metadata handler
+const metadata = await file.getMetaData();
+
+// Set custom metadata
+await metadata.setCustomMetaData({
+  key: 'author',
+  value: 'John Doe'
+});
+
+await metadata.setCustomMetaData({
+  key: 'department',
+  value: 'Engineering'
+});
+
+// Retrieve metadata
+const author = await metadata.getCustomMetaData({ key: 'author' });
+console.log(`📝 Author: ${author}`);
+
+// Get all metadata
+const allMeta = await metadata.getAllCustomMetaData();
+console.log('📋 All metadata:', allMeta);
 ```
 
-#### Deleting Files
+### 🗑️ Trash & Recovery
 
-Delete files with precision using `fastRemove`:
+SmartBucket includes an intelligent trash system for safe file deletion:
 
 ```typescript
-async function deleteFile(bucketName: string, filePath: string) {
+const file = await bucket.getBaseDirectory()
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  .getFileStrict({ path: 'important-data.xlsx' });
-  await bucket.fastRemove({ path: filePath });
-  console.log(`File ${filePath} deleted.`);
-}
 
-deleteFile("myBucket", "example.txt");
+// Move to trash instead of permanent deletion
+await file.delete({ mode: 'trash' });
+console.log('🗑️ File moved to trash');
+
+// Access trash
+const trash = await bucket.getTrash();
+const trashDir = await trash.getTrashDir();
+const trashedFiles = await trashDir.listFiles();
+console.log(`📦 ${trashedFiles.length} files in trash`);
+
+// Restore from trash
+const trashedFile = await bucket.getBaseDirectory()
+  .getFileStrict({ 
+    path: 'important-data.xlsx',
+    getFromTrash: true
+  });
+
+await trashedFile.restore({ useOriginalPath: true });
+console.log('♻️ File restored successfully');
+
+// Permanent deletion from trash
+await trash.emptyTrash();
+console.log('🧹 Trash emptied');
 ```
 
-### Directory Operations
+### ⚡ Advanced Features
 
-Leverage directory functionalities to better organize and manage files within buckets.
+#### File Statistics
-
-#### Listing Directories and Files
-
-Listing contents showcases a directory’s structure and file contents:
 
 ```typescript
-async function listDirectory(bucketName: string, directoryPath: string) {
+// Get detailed file statistics
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+const stats = await bucket.fastStat({ path: 'document.pdf' });
-  const baseDirectory: Directory = await bucket.getBaseDirectory();
+console.log(`📊 Size: ${stats.size} bytes`);
-  const targetDirectory = await baseDirectory.getSubDirectoryByName(directoryPath);
+console.log(`📅 Last modified: ${stats.lastModified}`);
-
+console.log(`🏷️ ETag: ${stats.etag}`);
-  console.log('Directories:');
-  (await targetDirectory.listDirectories()).forEach(dir => console.log(dir.name));
-
-  console.log('Files:');
-  (await targetDirectory.listFiles()).forEach(file => console.log(file.name));
-}
-
-listDirectory("myBucket", "path/to/directory");
 ```
 
-#### Managing Files in Directories
+#### Magic Bytes Detection
-
-Additional functionalities allow file management, inclusive of handling sub-directories:
 
 ```typescript
-async function manageFilesInDirectory(bucketName: string, directoryPath: string, fileName: string, content: string) {
+// Read first bytes for file type detection
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+const magicBytes = await bucket.getMagicBytes({
-  const baseDirectory: Directory = await bucket.getBaseDirectory();
+  path: 'mystery-file',
-  const directory = await baseDirectory.getSubDirectoryByName(directoryPath) ?? baseDirectory;
+  length: 16
+});
 
-  await directory.fastPut({ path: fileName, contents: content });
+// Or from a File object
-  console.log(`File ${fileName} created in ${directoryPath}`);
+const file = await bucket.getBaseDirectory()
-
+  .getFileStrict({ path: 'image.jpg' });
-  const fileContent = await directory.fastGet({ path: fileName });
+const magic = await file.getMagicBytes({ length: 4 });
-  console.log(`Content of ${fileName}: ${fileContent.toString()}`);
+console.log(`🔮 Magic bytes: ${magic.toString('hex')}`);
-}
-
-manageFilesInDirectory("myBucket", "myDir", "example.txt", "File content here");
 ```
 
-### Advanced Features
+#### JSON Data Operations
-
-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.
-
-#### Metadata Management
-
-Easily manage and store metadata by using the `MetaData` utility:
 
 ```typescript
-async function handleMetadata(bucketName: string, filePath: string) {
+const file = await bucket.getBaseDirectory()
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  .getFileStrict({ path: 'config.json' });
-  const meta = await bucket.fastStat({ path: filePath });
-  console.log("Metadata:", meta.Metadata);
-}
 
-handleMetadata("myBucket", "example.txt");
+// Read JSON data
+const config = await file.getJsonData();
+console.log('⚙️ Config loaded:', config);
+
+// Update JSON data
+config.version = '2.0';
+config.updated = new Date().toISOString();
+await file.writeJsonData(config);
+console.log('💾 Config updated');
 ```
 
-#### File Locking
+#### Directory & File Type Detection
-
-Prevent accidental writes by locking files:
 
 ```typescript
-async function lockFile(bucketName: string, filePath: string) {
+// Check if path is a directory
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+const isDir = await bucket.isDirectory({ path: 'uploads/' });
-  const file: File = await bucket.getBaseDirectory().getFileStrict({ path: filePath });
-  await file.lock({ timeoutMillis: 600000 }); // Lock for 10 minutes
-  console.log(`File ${filePath} locked.`);
-}
 
-lockFile("myBucket", "example.txt");
+// Check if path is a file
+const isFile = await bucket.isFile({ path: 'uploads/document.pdf' });
+
+console.log(`Is directory: ${isDir ? '📁' : '❌'}`);
+console.log(`Is file: ${isFile ? '📄' : '❌'}`);
 ```
 
-#### Trash Management
+#### Clean Bucket Contents
-
-SmartBucket enables a safe deletion mode where files can be moved to a recycling bin, allowing for restoration:
 
 ```typescript
-async function trashAndRestoreFile(bucketName: string, filePath: string) {
+// Remove all files and directories (use with caution!)
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+await bucket.cleanAllContents();
-  const file: File = await bucket.getBaseDirectory().getFileStrict({ path: filePath });
+console.log('🧹 Bucket cleaned');
-
-  // Move the file to trash
-  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
+### ☁️ Cloud Provider Support
 
-`@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.
+SmartBucket works seamlessly with:
 
-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.
+- ✅ **AWS S3** - Full compatibility with S3 API
+- ✅ **Google Cloud Storage** - Via S3-compatible API
+- ✅ **MinIO** - Self-hosted S3-compatible storage
+- ✅ **DigitalOcean Spaces** - S3-compatible object storage
+- ✅ **Backblaze B2** - Cost-effective cloud storage
+- ✅ **Wasabi** - High-performance S3-compatible storage
+- ✅ **Any S3-compatible provider**
+
+The library automatically handles provider quirks and optimizes operations for each platform while maintaining a consistent API.
+
+### 🔧 Advanced Configuration
+
+```typescript
+// Configure with custom options
+const smartBucket = new SmartBucket({
+  accessKey: process.env.S3_ACCESS_KEY,
+  accessSecret: process.env.S3_SECRET_KEY,
+  endpoint: process.env.S3_ENDPOINT,
+  port: 443,
+  useSsl: true,
+  region: 'eu-central-1',
+  // Additional S3 client options can be passed through
+});
+
+// Environment-based configuration
+import { Qenv } from '@push.rocks/qenv';
+const qenv = new Qenv('./', './.nogit/');
+
+const smartBucket = new SmartBucket({
+  accessKey: await qenv.getEnvVarOnDemandStrict('S3_ACCESS_KEY'),
+  accessSecret: await qenv.getEnvVarOnDemandStrict('S3_SECRET'),
+  endpoint: await qenv.getEnvVarOnDemandStrict('S3_ENDPOINT'),
+});
 ```
 
+### 🧪 Testing
+
+SmartBucket is thoroughly tested. Run tests with:
+
+```bash
+pnpm test
+```
+
+### 🤝 Best Practices
+
+1. **Always use strict mode** for critical operations to catch errors early
+2. **Implement proper error handling** for network and permission issues
+3. **Use streaming** for large files to optimize memory usage
+4. **Leverage metadata** for organizing and searching files
+5. **Enable trash mode** for important data to prevent accidental loss
+6. **Lock files** during critical operations to prevent race conditions
+7. **Clean up resources** properly when done
+
 ## License and Legal Information
 
 This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 

test/test.metadata.ts

@@ -1,7 +1,7 @@
-import { tap, expect } from '@push.rocks/tapbundle';
+import { tap, expect } from '@git.zone/tstest/tapbundle';
 
 tap.test('test metadata functionality', async () => {
 
 })
 
-tap.start();
+export default tap.start();

test/test.trash.ts

@@ -1,4 +1,4 @@
-import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
+import { expect, tap } from '@git.zone/tstest/tapbundle';
 import { jestExpect } from '@push.rocks/tapbundle/node';
 import { Qenv } from '@push.rocks/qenv';
 

test/test.ts

@@ -1,4 +1,4 @@
-import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
+import { expect, tap } from '@git.zone/tstest/tapbundle';
 import { Qenv } from '@push.rocks/qenv';
 
 import * as smartbucket from '../ts/index.js';
@@ -126,4 +126,4 @@ tap.test('clean up directory style tests', async () => {
   await myBucket.fastRemove({ path: 'file1.txt' });
 });
 
-tap.start();
+export default tap.start();

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartbucket',
-  version: '3.3.6',
+  version: '3.3.9',
   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.'
 }