3.3.9

fix(docs): Revise README with detailed usage examples and add local Claude settings
3.3.8
2025-08-15 18:31:42 +00:00 · 2025-08-15 18:31:42 +00:00 · 2025-08-15 18:28:27 +00:00 · 2025-08-15 18:28:27 +00:00 · 2024-12-02 17:00:42 +01:00 · 2024-12-02 17:00:42 +01:00
14 changed files with 3962 additions and 2718 deletions
--- a/.gitlab-ci.yml
+++ b/.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
--- a/changelog.md
+++ b/changelog.md
@@ -1,5 +1,49 @@
 # 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
+
+
+## 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.

--- a/19
+++ b/19
@@ -0,0 +1,19 @@
+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.
--- a/npmextra.json
+++ b/npmextra.json
@@ -8,32 +8,30 @@
      "githost": "code.foss.global",
      "gitscope": "push.rocks",
      "gitrepo": "smartbucket",
-      "description": "A TypeScript library facilitating cloud-agnostic object storage with capabilities such as bucket management, file operations, directory management, and advanced data streaming functionalities.",
+      "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.",
      "npmPackagename": "@push.rocks/smartbucket",
      "license": "MIT",
      "keywords": [
        "TypeScript",
-        "cloud storage",
+        "cloud agnostic",
        "object storage",
        "bucket management",
        "file operations",
        "directory management",
        "data streaming",
-        "multi-cloud",
        "S3",
-        "minio",
-        "API",
-        "unified storage",
+        "multi-cloud",
        "file locking",
        "metadata management",
        "buffer handling",
        "access control",
-        "cloud agnostic",
-        "data streaming",
+        "environment configuration",
+        "unified storage",
+        "bucket policies",
+        "trash management",
        "file transfer",
        "data management",
-        "streaming",
-        "environment configuration"
+        "streaming"
      ]
    }
  },
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
  "name": "@push.rocks/smartbucket",
-  "version": "3.3.2",
+  "version": "3.3.9",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "@push.rocks/smartbucket",
-      "version": "3.3.2",
+      "version": "3.3.9",
      "license": "UNLICENSED",
      "dependencies": {
        "@push.rocks/smartpath": "^5.0.18",
--- a/package.json
+++ b/package.json
@@ -1,33 +1,33 @@
 {
  "name": "@push.rocks/smartbucket",
-  "version": "3.3.2",
-  "description": "A TypeScript library facilitating cloud-agnostic object storage with capabilities such as bucket management, file operations, directory management, and advanced data streaming functionalities.",
+  "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",
-  "license": "UNLICENSED",
+  "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",
-    "@push.rocks/qenv": "^6.1.0",
-    "@push.rocks/tapbundle": "^5.5.3"
+    "@git.zone/tstest": "^2.3.2",
+    "@push.rocks/qenv": "^6.1.2",
+    "@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/smartpromise": "^4.0.4",
-    "@push.rocks/smartrx": "^3.0.7",
+    "@push.rocks/smartpath": "^6.0.0",
+    "@push.rocks/smartpromise": "^4.2.3",
+    "@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": [
@@ -47,31 +47,30 @@
  ],
  "keywords": [
    "TypeScript",
-    "cloud storage",
+    "cloud agnostic",
    "object storage",
    "bucket management",
    "file operations",
    "directory management",
    "data streaming",
-    "multi-cloud",
    "S3",
-    "minio",
-    "API",
-    "unified storage",
+    "multi-cloud",
    "file locking",
    "metadata management",
    "buffer handling",
    "access control",
-    "cloud agnostic",
-    "data streaming",
+    "environment configuration",
+    "unified storage",
+    "bucket policies",
+    "trash management",
    "file transfer",
    "data management",
-    "streaming",
-    "environment configuration"
+    "streaming"
  ],
  "homepage": "https://code.foss.global/push.rocks/smartbucket",
  "repository": {
    "type": "git",
    "url": "https://code.foss.global/push.rocks/smartbucket.git"
-  }
+  },
+  "packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748"
 }
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
--- a/pnpm-workspace.yaml
+++ b/pnpm-workspace.yaml
@@ -0,0 +1,4 @@
+onlyBuiltDependencies:
+  - esbuild
+  - mongodb-memory-server
+  - puppeteer
--- a/readme.hints.md
+++ b/readme.hints.md
@@ -1 +1,3 @@
- 
+* 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!
--- a/readme.md
+++ b/readme.md
@@ -1,251 +1,456 @@
-```markdown
-# @push.rocks/smartbucket
+# @push.rocks/smartbucket 🪣

-A TypeScript library offering simple and cloud-agnostic object storage with advanced features like bucket creation, file and directory management, and 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 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)
-2. [Working with Buckets](#working-with-buckets)
-    - [Creating a New Bucket](#creating-a-new-bucket)
-    - [Listing Buckets](#listing-buckets)
-    - [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)
-    - [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)
-6. [Cloud Agnosticism](#cloud-agnosticism)
+1. [🏁 Getting Started](#-getting-started)
+2. [🗂️ Working with Buckets](#️-working-with-buckets)
+3. [📁 File Operations](#-file-operations)
+4. [📂 Directory Management](#-directory-management)
+5. [🌊 Streaming Operations](#-streaming-operations)
+6. [🔒 File Locking](#-file-locking)
+7. [🏷️ Metadata Management](#️-metadata-management)
+8. [🗑️ Trash & Recovery](#️-trash--recovery)
+9. [⚡ Advanced Features](#-advanced-features)
+10. [☁️ Cloud Provider Support](#️-cloud-provider-support)

-### Setting Up
+### 🏁 Getting Started

-Start by setting up `@push.rocks/smartbucket` in a TypeScript file, ensuring your project uses ECMAScript modules:
+First, set up your storage connection:

 ```typescript
-import {
-  SmartBucket,
-  Bucket,
-  Directory,
-  File
-} from '@push.rocks/smartbucket';
+import { SmartBucket } from '@push.rocks/smartbucket';

-const mySmartBucket = new SmartBucket({
-  accessKey: "yourAccessKey",
-  accessSecret: "yourSecretKey",
-  endpoint: "yourEndpointURL",
+// Initialize with your cloud storage credentials
+const smartBucket = new SmartBucket({
+  accessKey: 'your-access-key',
+  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 appropriate values for your cloud storage service.
+### 🗂️ Working with Buckets

-### Working with Buckets
-
-#### Creating a New Bucket
-
-To create a new bucket, use the `createBucket` method. Remember that bucket names must be unique across the storage service:
+#### Creating Buckets

 ```typescript
-async function createBucket(bucketName: string) {
-  try {
-    const newBucket: Bucket = await mySmartBucket.createBucket(bucketName);
-    console.log(`Bucket ${bucketName} created successfully.`);
-  } catch (error) {
-    console.error("Error creating bucket:", error);
+// Create a new bucket
+const myBucket = await smartBucket.createBucket('my-awesome-bucket');
+console.log(`✅ Bucket created: ${myBucket.name}`);
+```
+
+#### 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
-
-SmartBucket allows you to manage buckets but relies on the cloud provider's SDK for listing them. 
-
-#### Deleting Buckets
-
-You can delete a bucket using the `removeBucket` method:
+#### Reactive Streams with RxJS

 ```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);
-  }
-}
+// Get file as ReplaySubject for reactive programming
+const replaySubject = await bucket.fastGetReplaySubject({
+  path: 'data/sensor-readings.json',
+  chunkSize: 1024
+});

-deleteBucket("myNewBucket");
+replaySubject.subscribe({
+  next: (chunk) => processChunk(chunk),
+  complete: () => console.log('✅ Stream complete')
+});
 ```

-### File Operations in Buckets
+### 🔒 File Locking

-#### Uploading Files
-
-To upload a file to a bucket, use the `fastPut` method:
+Prevent accidental modifications with file locking:

 ```typescript
-async function uploadFile(bucketName: string, filePath: string, fileContent: Buffer | string) {
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  await bucket.fastPut({ path: filePath, contents: fileContent });
-  console.log(`File uploaded to ${bucketName} at ${filePath}`);
+const file = await bucket.getBaseDirectory()
+  .getFileStrict({ path: 'important-config.json' });
+
+// 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');
 }

-uploadFile("myBucket", "example.txt", "This is a sample file content.");
+// Unlock when done
+await file.unlock();
+console.log('🔓 File unlocked');
 ```

-#### Downloading Files
+### 🏷️ Metadata Management

-Retrieve files using the `fastGet` method:
+Attach and manage metadata for your files:

 ```typescript
-async function downloadFile(bucketName: string, filePath: string) {
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  const content: Buffer = await bucket.fastGet({ path: filePath });
-  console.log("Downloaded content:", content.toString());
-}
+const file = await bucket.getBaseDirectory()
+  .getFileStrict({ path: 'document.pdf' });

-downloadFile("myBucket", "example.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);
 ```

-#### Streaming Files
+### 🗑️ Trash & Recovery

-For large files, use streams:
+SmartBucket includes an intelligent trash system for safe file deletion:

 ```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."));
-}
+const file = await bucket.getBaseDirectory()
+  .getFileStrict({ path: 'important-data.xlsx' });

-streamFile("myBucket", "largefile.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');
 ```

-#### Deleting Files
+### ⚡ Advanced Features

-Remove files with the `fastRemove` method:
+#### File Statistics

 ```typescript
-async function deleteFile(bucketName: string, filePath: string) {
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  await bucket.fastRemove({ path: filePath });
-  console.log(`File ${filePath} deleted from ${bucketName}.`);
-}
-
-deleteFile("myBucket", "example.txt");
+// Get detailed file statistics
+const stats = await bucket.fastStat({ path: 'document.pdf' });
+console.log(`📊 Size: ${stats.size} bytes`);
+console.log(`📅 Last modified: ${stats.lastModified}`);
+console.log(`🏷️ ETag: ${stats.etag}`);
 ```

-### Directory Operations
-
-#### Listing Directories and Files
-
-You can navigate and list files in directories within a bucket:
+#### Magic Bytes Detection

 ```typescript
-async function listDirectory(bucketName: string, directoryPath: string) {
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  const baseDirectory: Directory = await bucket.getBaseDirectory();
-  const targetDirectory = await baseDirectory.getSubDirectoryByName(directoryPath);
+// Read first bytes for file type detection
+const magicBytes = await bucket.getMagicBytes({
+  path: 'mystery-file',
+  length: 16
+});

-  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");
+// Or from a File object
+const file = await bucket.getBaseDirectory()
+  .getFileStrict({ path: 'image.jpg' });
+const magic = await file.getMagicBytes({ length: 4 });
+console.log(`🔮 Magic bytes: ${magic.toString('hex')}`);
 ```

-#### Managing Files in Directories
-
-Upload, download, and manage files using directory abstractions:
+#### JSON Data Operations

 ```typescript
-async function manageFilesInDirectory(bucketName: string, directoryPath: string, fileName: string, content: string) {
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  const baseDirectory: Directory = await bucket.getBaseDirectory();
-  const directory = await baseDirectory.getSubDirectoryByName(directoryPath) ?? baseDirectory;
+const file = await bucket.getBaseDirectory()
+  .getFileStrict({ path: 'config.json' });

-  await directory.fastPut({ path: fileName, contents: content });
-  console.log(`File ${fileName} created in ${directoryPath}`);
+// Read JSON data
+const config = await file.getJsonData();
+console.log('⚙️ Config loaded:', config);

-  const fileContent = await directory.fastGet({ path: fileName });
-  console.log(`Content of ${fileName}: ${fileContent.toString()}`);
-}
-
-manageFilesInDirectory("myBucket", "myDir", "example.txt", "File content here");
+// Update JSON data
+config.version = '2.0';
+config.updated = new Date().toISOString();
+await file.writeJsonData(config);
+console.log('💾 Config updated');
 ```

-### Advanced Features
-
-#### Bucket Policies
-
-SmartBucket facilitates bucket policy management, depending on the cloud SDK's capabilities.
-
-#### Metadata Management
-
-You can retrieve and manipulate object metadata, employing it for additional data storage:
+#### Directory & File Type Detection

 ```typescript
-async function handleMetadata(bucketName: string, filePath: string) {
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  const meta = await bucket.smartbucketRef.s3Client.send(new plugins.s3.HeadObjectCommand({
-    Bucket: bucket.name,
-    Key: filePath,
-  }));
-  console.log("Metadata:", meta.Metadata);
-}
+// Check if path is a directory
+const isDir = await bucket.isDirectory({ path: 'uploads/' });

-handleMetadata("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 ? '📄' : '❌'}`);
 ```

-#### File Locking
-
-Lock files to prevent changes:
+#### Clean Bucket Contents

 ```typescript
-async function lockFile(bucketName: string, filePath: string) {
-  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  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");
+// Remove all files and directories (use with caution!)
+await bucket.cleanAllContents();
+console.log('🧹 Bucket cleaned');
 ```

-### Cloud Agnosticism
+### ☁️ Cloud Provider Support

-`@push.rocks/smartbucket` supports multiple cloud providers, enhancing flexibility in cloud strategies without significant code changes. Adjust configurations as necessary for different providers, as services like AWS S3 or Google Cloud Storage might offer unique features beyond SmartBucket's unified interface.
+SmartBucket works seamlessly with:

-This guide demonstrates various operations with `@push.rocks/smartbucket`. Always refer to the comprehensive documentation and cloud provider details to fully leverage the library's capabilities.
+- ✅ **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'),
+});
 ```

-This readme provides detailed documentation on using the `@push.rocks/smartbucket` module, demonstrating its capabilities through comprehensive examples and use cases. Each section is designed to guide a user through basic to more complex operations, ensuring a complete presentation of the library's features.
+### 🧪 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

@@ -264,4 +469,4 @@ Registered at District court Bremen HRB 35230 HB, Germany

 For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.

-By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
--- a/test/test.metadata.ts
+++ b/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();
--- a/test/test.trash.ts
+++ b/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';

@@ -52,7 +52,21 @@ 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",
--- a/test/test.ts
+++ b/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();
--- a/ts/00_commitinfo_data.ts
+++ b/ts/00_commitinfo_data.ts
@@ -3,6 +3,6 @@
 */
 export const commitinfo = {
  name: '@push.rocks/smartbucket',
-  version: '3.3.2',
-  description: 'A TypeScript library facilitating cloud-agnostic object storage with capabilities such as bucket management, file operations, directory management, and advanced data streaming functionalities.'
+  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.'
 }
Author	SHA1	Message	Date
Juergen Kunz	fa4c44ae04	3.3.9	2025-08-15 18:31:42 +00:00
Juergen Kunz	708b0b63b1	fix(docs): Revise README with detailed usage examples and add local Claude settings	2025-08-15 18:31:42 +00:00
Juergen Kunz	8554554642	3.3.8	2025-08-15 18:28:27 +00:00
Juergen Kunz	a04aabf78b	fix(tests): Update tests to use @git.zone/tstest, upgrade dependencies, remove GitLab CI and add local CI/workspace config	2025-08-15 18:28:27 +00:00
Philipp Kunz	47cf2cc2cb	3.3.7	2024-12-02 17:00:42 +01:00
Philipp Kunz	ef20e15d20	fix(package): Update author field in package.json	2024-12-02 17:00:42 +01:00
Philipp Kunz	39a4bd6ab7	3.3.6	2024-12-02 17:00:17 +01:00
Philipp Kunz	c2a30654c5	fix(package): Fix license field in package.json to reflect MIT licensing	2024-12-02 17:00:17 +01:00
Philipp Kunz	8085033de4	3.3.5	2024-11-25 17:43:01 +01:00
Philipp Kunz	75dd1d43a9	fix(test): Refactor trash test to improve metadata and deletion validation	2024-11-25 17:43:00 +01:00
Philipp Kunz	8ba7cdc873	3.3.4	2024-11-25 17:36:14 +01:00
Philipp Kunz	ed8db4536b	fix(core): Minor refactoring and cleanup of TypeScript source files for improved readability and maintainability.	2024-11-25 17:36:14 +01:00
Philipp Kunz	96e3eadb31	3.3.3	2024-11-24 20:12:21 +01:00
Philipp Kunz	e9426b9cc9	fix(documentation): Improved documentation accuracy and consistency	2024-11-24 20:12:20 +01:00