3.3.2

changelog.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 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.
+
+- Corrected the order of operations in the file restore function to ensure custom metadata is appropriately deleted after moving the file.
+
+## 2024-11-24 - 3.3.0 - feat(core)
+Enhanced directory handling and file restoration from trash
+
+- Refined getSubDirectoryByName to handle file paths treated as directories.
+- Introduced file restoration function from trash to original or specified paths.
+
+## 2024-11-24 - 3.2.2 - fix(core)
+Refactor Bucket class for improved error handling
+
+- Ensured safe access using non-null assertions when finding a bucket.
+- Enhanced fastPut method by adding fastPutStrict for safer operations.
+- Added explicit error handling and type checking in fastExists method.
+
 ## 2024-11-24 - 3.2.1 - fix(metadata)
 Fix metadata handling for deleted files
 

npmextra.json

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

package-lock.json

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

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@push.rocks/smartbucket",
-  "version": "3.2.1",
+  "version": "3.3.2",
-  "description": "A TypeScript library offering simple and cloud-agnostic object storage with advanced features like bucket creation, file and directory management, and data streaming.",
+  "description": "A TypeScript library facilitating cloud-agnostic object storage with capabilities such as bucket management, file operations, directory management, and advanced data streaming functionalities.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "type": "module",
@@ -49,21 +49,25 @@
     "TypeScript",
     "cloud storage",
     "object storage",
-    "bucket creation",
+    "bucket management",
-    "file management",
+    "file operations",
     "directory management",
     "data streaming",
     "multi-cloud",
-    "API",
-    "unified storage",
     "S3",
     "minio",
+    "API",
+    "unified storage",
     "file locking",
-    "metadata",
+    "metadata management",
     "buffer handling",
-    "access key",
+    "access control",
-    "secret key",
+    "cloud agnostic",
-    "cloud agnostic"
+    "data streaming",
+    "file transfer",
+    "data management",
+    "streaming",
+    "environment configuration"
   ],
   "homepage": "https://code.foss.global/push.rocks/smartbucket",
   "repository": {

readme.md

@@ -1,41 +1,44 @@
+```markdown
 # @push.rocks/smartbucket
 
-A TypeScript library for cloud-independent object storage, providing features like bucket creation, file and directory management, and data streaming.
+A TypeScript library offering simple and cloud-agnostic object storage with advanced features like bucket creation, file and directory management, and data streaming.
 
 ## Install
 
-To install `@push.rocks/smartbucket`, you need to have Node.js and npm (Node Package Manager) installed. If they are installed, you can add `@push.rocks/smartbucket` to your project by running the following command in your project's root directory:
+To install `@push.rocks/smartbucket`, ensure you have Node.js and npm installed. Then, run the following command in your project directory:
 
 ```bash
 npm install @push.rocks/smartbucket --save
 ```
 
-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.
+This command will add `@push.rocks/smartbucket` to your project's dependencies and install it along with its requirements in the `node_modules` directory.
 
 ## Usage
 
-`@push.rocks/smartbucket` is a TypeScript module designed to provide simple cloud-independent object storage functionality. It wraps various cloud storage providers such as AWS S3, Google Cloud Storage, and others, offering a unified API to manage storage buckets and objects within those buckets.
-
-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. [Creating a New Bucket](#creating-a-new-bucket)
+2. [Working with Buckets](#working-with-buckets)
-3. [Listing Buckets](#listing-buckets)
+    - [Creating a New Bucket](#creating-a-new-bucket)
-4. [Working with Files](#working-with-files)
+    - [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)
-    - [Deleting Files](#deleting-files)
     - [Streaming Files](#streaming-files)
-5. [Working with Directories](#working-with-directories)
+    - [Deleting Files](#deleting-files)
-6. [Advanced Features](#advanced-features)
+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)
-    - [Object Metadata](#object-metadata)
+    - [Metadata Management](#metadata-management)
-    - [Cloud Agnostic](#cloud-agnostic)
+    - [File Locking](#file-locking)
+6. [Cloud Agnosticism](#cloud-agnosticism)
 
 ### Setting Up
 
-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:
+Start by setting up `@push.rocks/smartbucket` in a TypeScript file, ensuring your project uses ECMAScript modules:
 
 ```typescript
 import {
@@ -49,264 +52,200 @@ const mySmartBucket = new SmartBucket({
   accessKey: "yourAccessKey",
   accessSecret: "yourSecretKey",
   endpoint: "yourEndpointURL",
-  port: 443,            // Default is 443, can be customized for specific endpoint
+  port: 443,
-  useSsl: true          // Defaults to true
+  useSsl: true
 });
 ```
 
-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.
+Replace `"yourAccessKey"`, `"yourSecretKey"`, and `"yourEndpointURL"` with appropriate values for your cloud storage service.
 
-### Creating a New Bucket
+### Working with Buckets
 
-To create a new bucket:
+#### Creating a New Bucket
+
+To create a new bucket, use the `createBucket` method. Remember that bucket names must be unique across the storage service:
 
 ```typescript
 async function createBucket(bucketName: string) {
   try {
-    const myBucket: Bucket = await mySmartBucket.createBucket(bucketName);
+    const newBucket: Bucket = await mySmartBucket.createBucket(bucketName);
     console.log(`Bucket ${bucketName} created successfully.`);
   } catch (error) {
     console.error("Error creating bucket:", error);
   }
 }
 
-// Use the function
+createBucket("myNewBucket");
-createBucket("exampleBucket");
 ```
 
-Bucket names must be unique across the storage service.
+#### Listing Buckets
 
-### Listing Buckets
+SmartBucket allows you to manage buckets but relies on the cloud provider's SDK for listing them. 
 
-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.
+#### Deleting Buckets
 
-### Working with Files
+You can delete a bucket using the `removeBucket` method:
+
+```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("myNewBucket");
+```
+
+### File Operations in Buckets
 
 #### Uploading Files
 
-To upload an object to a bucket:
+To upload a file to a bucket, use the `fastPut` method:
 
 ```typescript
 async function uploadFile(bucketName: string, filePath: string, fileContent: Buffer | string) {
-  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  if (myBucket) {
+  await bucket.fastPut({ path: filePath, contents: fileContent });
-    await myBucket.fastPut({ path: filePath, contents: fileContent });
   console.log(`File uploaded to ${bucketName} at ${filePath}`);
-  } else {
-    console.error(`Bucket ${bucketName} does not exist.`);
-  }
 }
 
-// Use the function
+uploadFile("myBucket", "example.txt", "This is a sample file content.");
-uploadFile("exampleBucket", "path/to/object.txt", "Hello, world!");
 ```
 
 #### Downloading Files
 
-To download an object:
+Retrieve files using the `fastGet` method:
 
 ```typescript
 async function downloadFile(bucketName: string, filePath: string) {
-  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  if (myBucket) {
+  const content: Buffer = await bucket.fastGet({ path: filePath });
-    const fileContent: Buffer = await myBucket.fastGet({ path: filePath });
+  console.log("Downloaded content:", content.toString());
-    console.log("Downloaded file content:", fileContent.toString());
-  } else {
-    console.error(`Bucket ${bucketName} does not exist.`);
-  }
 }
 
-// Use the function
+downloadFile("myBucket", "example.txt");
-downloadFile("exampleBucket", "path/to/object.txt");
-```
-
-#### Deleting Files
-
-To delete an object from a bucket:
-
-```typescript
-async function deleteFile(bucketName: string, filePath: string) {
-  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  if (myBucket) {
-    await myBucket.fastRemove({ path: filePath });
-    console.log(`File at ${filePath} deleted from ${bucketName}.`);
-  } else {
-    console.error(`Bucket ${bucketName} does not exist.`);
-  }
-}
-
-// Use the function
-deleteFile("exampleBucket", "path/to/object.txt");
 ```
 
 #### Streaming Files
 
-SmartBucket allows you to work with file streams, which can be useful for handling large files. 
+For large files, use streams:
-
-To read a file as a stream:
 
 ```typescript
-import { ReplaySubject } from '@push.rocks/smartrx';
+async function streamFile(bucketName: string, filePath: string) {
-
+  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-async function readFileStream(bucketName: string, filePath: string) {
+  const stream = await bucket.fastGetStream({ path: filePath }, "nodestream");
-  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  stream.on('data', chunk => console.log("Chunk:", chunk.toString()));
-  if (myBucket) {
+  stream.on('end', () => console.log("Download completed."));
-    const fileStream: ReplaySubject<Buffer> = await myBucket.fastGetStream({ path: filePath });
-    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.`);
-  }
 }
 
-// Use the function
+streamFile("myBucket", "largefile.txt");
-readFileStream("exampleBucket", "path/to/object.txt");
 ```
 
-To write a file as a stream:
+#### Deleting Files
+
+Remove files with the `fastRemove` method:
 
 ```typescript
-import { Readable } from 'stream';
+async function deleteFile(bucketName: string, filePath: string) {
-
+  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-async function writeFileStream(bucketName: string, filePath: string, readableStream: Readable) {
+  await bucket.fastRemove({ path: filePath });
-  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  console.log(`File ${filePath} deleted from ${bucketName}.`);
-  if (myBucket) {
-    await myBucket.fastPutStream({ path: filePath, dataStream: readableStream });
-    console.log(`File streamed to ${bucketName} at ${filePath}`);
-  } else {
-    console.error(`Bucket ${bucketName} does not exist.`);
-  }
 }
 
-// Create a readable stream from a string
+deleteFile("myBucket", "example.txt");
-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
+### Directory Operations
 
-`@push.rocks/smartbucket` offers abstractions for directories within buckets for easier object management. You can create, list, and delete directories using the `Directory` class.
+#### Listing Directories and Files
 
-To list the contents of a directory:
+You can navigate and list files in directories within a bucket:
 
 ```typescript
-async function listDirectoryContents(bucketName: string, directoryPath: string) {
+async function listDirectory(bucketName: string, directoryPath: string) {
-  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  if (myBucket) {
+  const baseDirectory: Directory = await bucket.getBaseDirectory();
-    const baseDirectory: Directory = await myBucket.getBaseDirectory();
+  const targetDirectory = await baseDirectory.getSubDirectoryByName(directoryPath);
-    const targetDirectory: Directory = await baseDirectory.getSubDirectoryByName(directoryPath);
 
-    console.log('Listing directories:');
+  console.log('Directories:');
-    const directories = await targetDirectory.listDirectories();
+  (await targetDirectory.listDirectories()).forEach(dir => console.log(dir.name));
-    directories.forEach(dir => {
-      console.log(`- ${dir.name}`);
-    });
 
-    console.log('Listing files:');
+  console.log('Files:');
-    const files = await targetDirectory.listFiles();
+  (await targetDirectory.listFiles()).forEach(file => console.log(file.name));
-    files.forEach(file => {
-      console.log(`- ${file.name}`);
-    });
-  } else {
-    console.error(`Bucket ${bucketName} does not exist.`);
-  }
 }
 
-// Use the function
+listDirectory("myBucket", "path/to/directory");
-listDirectoryContents("exampleBucket", "some/directory/path");
 ```
 
-To create a file within a directory:
+#### Managing Files in Directories
+
+Upload, download, and manage files using directory abstractions:
 
 ```typescript
-async function createFileInDirectory(bucketName: string, directoryPath: string, fileName: string, fileContent: string) {
+async function manageFilesInDirectory(bucketName: string, directoryPath: string, fileName: string, content: string) {
-  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  if (myBucket) {
+  const baseDirectory: Directory = await bucket.getBaseDirectory();
-    const baseDirectory: Directory = await myBucket.getBaseDirectory();
+  const directory = await baseDirectory.getSubDirectoryByName(directoryPath) ?? baseDirectory;
-    const targetDirectory: Directory = await baseDirectory.getSubDirectoryByName(directoryPath);
+
-    await targetDirectory.createEmptyFile(fileName); // Create an empty file
+  await directory.fastPut({ path: fileName, contents: content });
-    const file = new File({ directoryRefArg: targetDirectory, fileName });
+  console.log(`File ${fileName} created in ${directoryPath}`);
-    await file.updateWithContents({ contents: fileContent });
+
-    console.log(`File created: ${fileName}`);
+  const fileContent = await directory.fastGet({ path: fileName });
-  } else {
+  console.log(`Content of ${fileName}: ${fileContent.toString()}`);
-    console.error(`Bucket ${bucketName} does not exist.`);
-  }
 }
 
-// Use the function
+manageFilesInDirectory("myBucket", "myDir", "example.txt", "File content here");
-createFileInDirectory("exampleBucket", "some/directory", "newfile.txt", "Hello, world!");
 ```
 
 ### Advanced Features
 
 #### Bucket Policies
 
-Manage bucket policies to control access permissions. This feature depends on the policies provided by the storage service (e.g., AWS S3, MinIO).
+SmartBucket facilitates bucket policy management, depending on the cloud SDK's capabilities.
 
-#### Object Metadata
+#### Metadata Management
 
-Retrieve and modify object metadata. Metadata can be useful for storing additional information about an object.
+You can retrieve and manipulate object metadata, employing it for additional data storage:
-
-To retrieve metadata:
 
 ```typescript
-async function getObjectMetadata(bucketName: string, filePath: string) {
+async function handleMetadata(bucketName: string, filePath: string) {
-  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  if (myBucket) {
+  const meta = await bucket.smartbucketRef.s3Client.send(new plugins.s3.HeadObjectCommand({
-    const metadata = await mySmartBucket.minioClient.statObject(bucketName, filePath);
+    Bucket: bucket.name,
-    console.log("Object metadata:", metadata);
+    Key: filePath,
-  } else {
+  }));
-    console.error(`Bucket ${bucketName} does not exist.`);
+  console.log("Metadata:", meta.Metadata);
-  }
 }
 
-// Use the function
+handleMetadata("myBucket", "example.txt");
-getObjectMetadata("exampleBucket", "path/to/object.txt");
 ```
 
-To update metadata:
+#### File Locking
+
+Lock files to prevent changes:
 
 ```typescript
-async function updateObjectMetadata(bucketName: string, filePath: string, newMetadata: { [key: string]: string }) {
+async function lockFile(bucketName: string, filePath: string) {
-  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  const bucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
-  if (myBucket) {
+  const file: File = await bucket.getBaseDirectory().getFileStrict({ path: filePath });
-    await myBucket.copyObject({
+  await file.lock({ timeoutMillis: 600000 }); // Lock for 10 minutes
-      objectKey: filePath,
+  console.log(`File ${filePath} locked.`);
-      nativeMetadata: newMetadata,
-      deleteExistingNativeMetadata: false,
-    });
-    console.log(`Metadata updated for ${filePath}`);
-  } else {
-    console.error(`Bucket ${bucketName} does not exist.`);
-  }
 }
 
-// Use the function
+lockFile("myBucket", "example.txt");
-updateObjectMetadata("exampleBucket", "path/to/object.txt", {
-  customKey: "customValue"
-});
 ```
 
-#### Cloud Agnostic
+### Cloud Agnosticism
 
-`@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.
+`@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.
 
-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.
+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.
+```
 
-This guide covers the basic to advanced scenarios of using `@push.rocks/smartbucket`. For further details, refer to the API documentation and examples.
+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.
 
 ## License and Legal Information
 

test/test.trash.ts

@@ -30,7 +30,7 @@ tap.test('should clean all contents', async () => {
 
 tap.test('should delete a file into the normally', async () => {
   const path = 'trashtest/trashme.txt';
-  const file = await myBucket.fastPut({
+  const file = await myBucket.fastPutStrict({
     path,
     contents: 'I\'m in the trash test content!',
   });
@@ -44,7 +44,7 @@ tap.test('should delete a file into the normally', async () => {
 
 tap.test('should put a file into the trash', async () => {
   const path = 'trashtest/trashme.txt';
-  const file = await myBucket.fastPut({
+  const file = await myBucket.fastPutStrict({
     path,
     contents: 'I\'m in the trash test content!',
   });
@@ -60,4 +60,19 @@ tap.test('should put a file into the trash', async () => {
   });
 });
 
+tap.test('should restore a file from trash', async () => {
+  const baseDirectory = await myBucket.getBaseDirectory();
+  const file = await baseDirectory.getFileStrict({
+    path: 'trashtest/trashme.txt',
+    getFromTrash: true
+  });
+  const trashFileMeta = await file.getMetaData();
+  const data = await trashFileMeta.getCustomMetaData({
+    key: 'recycle'
+  });
+  expect(file).toBeInstanceOf(smartbucket.File);
+  await file.restore();
+});
+
+
 export default tap.start();

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartbucket',
-  version: '3.2.1',
+  version: '3.3.2',
-  description: 'A TypeScript library offering simple and cloud-agnostic object storage with advanced features like bucket creation, file and directory management, and data streaming.'
+  description: 'A TypeScript library facilitating cloud-agnostic object storage with capabilities such as bucket management, file operations, directory management, and advanced data streaming functionalities.'
 }

ts/classes.bucket.ts

@@ -17,7 +17,7 @@ export class Bucket {
   public static async getBucketByName(smartbucketRef: SmartBucket, bucketNameArg: string) {
     const command = new plugins.s3.ListBucketsCommand({});
     const buckets = await smartbucketRef.s3Client.send(command);
-    const foundBucket = buckets.Buckets.find((bucket) => bucket.Name === bucketNameArg);
+    const foundBucket = buckets.Buckets!.find((bucket) => bucket.Name === bucketNameArg);
 
     if (foundBucket) {
       console.log(`bucket with name ${bucketNameArg} exists.`);
@@ -88,14 +88,15 @@ export class Bucket {
       contents: string | Buffer;
       overwrite?: boolean;
     }
-  ): Promise<File> {
+  ): Promise<File | null> {
     try {
       const reducedPath = await helpers.reducePathDescriptorToPath(optionsArg);
       const exists = await this.fastExists({ path: reducedPath });
 
       if (exists && !optionsArg.overwrite) {
-        console.error(`Object already exists at path '${reducedPath}' in bucket '${this.name}'.`);
+        const errorText = `Object already exists at path '${reducedPath}' in bucket '${this.name}'.`;
-        return;
+        console.error(errorText);
+        return null;
       } else if (exists && optionsArg.overwrite) {
         console.log(
           `Overwriting existing object at path '${reducedPath}' in bucket '${this.name}'.`
@@ -128,6 +129,14 @@ export class Bucket {
     }
   }
 
+  public async fastPutStrict(...args: Parameters<Bucket['fastPut']>) {
+    const file = await this.fastPut(...args);
+    if (!file) {
+      throw new Error(`File not stored at path '${args[0].path}'`);
+    }
+    return file;
+  }
+
   /**
    * get file
    */
@@ -152,7 +161,7 @@ export class Bucket {
       },
     });
     await done.promise;
-    return completeFile;
+    return completeFile!;
   }
 
   /**
@@ -220,7 +229,7 @@ export class Bucket {
         return chunk;
       },
       finalFunction: async (cb) => {
-        return null;
+        return null!;
       },
     });
 
@@ -392,8 +401,8 @@ export class Bucket {
       await this.smartbucketRef.s3Client.send(command);
       console.log(`Object '${optionsArg.path}' exists in bucket '${this.name}'.`);
       return true;
-    } catch (error) {
+    } catch (error: any) {
-      if (error.name === 'NotFound') {
+      if (error?.name === 'NotFound') {
         console.log(`Object '${optionsArg.path}' does not exist in bucket '${this.name}'.`);
         return false;
       } else {

ts/classes.directory.ts

@@ -10,9 +10,9 @@ export class Directory {
   public parentDirectoryRef: Directory;
   public name: string;
 
-  public tree: string[];
+  public tree!: string[];
-  public files: string[];
+  public files!: string[];
-  public folders: string[];
+  public folders!: string[];
 
   constructor(bucketRefArg: Bucket, parentDirectory: Directory, name: string) {
     this.bucketRef = bucketRefArg;
@@ -192,9 +192,22 @@ export class Directory {
    * gets a sub directory by name
    */
   public async getSubDirectoryByName(dirNameArg: string, optionsArg: {
+    /**
+     * in s3 a directory does not exist if it is empty
+     * this option returns a directory even if it is empty
+     */
     getEmptyDirectory?: boolean;
+    /**
+     * in s3 a directory does not exist if it is empty
+     * this option creates a directory even if it is empty using a initializer file
+     */
     createWithInitializerFile?: boolean;
+    /**
+     * if the path is a file path, it will be treated as a file and the parent directory will be returned
+     */
+    couldBeFilePath?: boolean;
   } = {}): Promise<Directory | null> {
+
     const dirNameArray = dirNameArg.split('/').filter(str => str.trim() !== "");
 
     optionsArg = {
@@ -221,6 +234,17 @@ export class Directory {
       return returnDirectory || null;
     };
 
+    if (optionsArg.couldBeFilePath) {
+      const baseDirectory = await this.bucketRef.getBaseDirectory();
+      const existingFile = await baseDirectory.getFile({
+        path: dirNameArg,
+      });
+      if (existingFile) {
+        const adjustedPath = dirNameArg.substring(0, dirNameArg.lastIndexOf('/'));
+        return this.getSubDirectoryByName(adjustedPath);
+      }
+    }
+
     let wantedDirectory: Directory | null = null;
     let counter = 0;
     for (const dirNameToSearch of dirNameArray) {
@@ -336,7 +360,7 @@ export class Directory {
      */
     mode?: 'permanent' | 'trash';
   }) {
-    const file = await this.getFile({
+    const file = await this.getFileStrict({
       path: optionsArg.path,
     });
     await file.delete({

ts/classes.file.ts

@@ -130,6 +130,33 @@ export class File {
     await this.parentDirectoryRef.listFiles();
   }
 
+  /**
+   * restores
+   */
+  public async restore(optionsArg: {
+    useOriginalPath?: boolean;
+    toPath?: string;
+    overwrite?: boolean;
+  } = {}) {
+    optionsArg = {
+      useOriginalPath: (() => {
+        return optionsArg.toPath ? false : true;
+      })(),
+      overwrite: false,
+      ...optionsArg,
+    };
+    const metadata = await this.getMetaData();
+    const moveToPath = optionsArg.toPath || (await metadata.getCustomMetaData({
+      key: 'recycle'
+    })).originalPath;
+    await metadata.deleteCustomMetaData({
+      key: 'recycle'
+    })
+    await this.move({
+      path: moveToPath,
+    });
+  }
+
   /**
    * allows locking the file
    * @param optionsArg
@@ -154,7 +181,7 @@ export class File {
   }) {
     const metadata = await this.getMetaData();
     await metadata.removeLock({
-      force: optionsArg?.force,
+      force: optionsArg?.force || false,
     });
   }
 
@@ -219,7 +246,10 @@ export class File {
     // lets update references of this
     const baseDirectory = await this.parentDirectoryRef.bucketRef.getBaseDirectory();
     this.parentDirectoryRef = await baseDirectory.getSubDirectoryByNameStrict(
-      pathDescriptorArg.directory?.getBasePath()!
+      await helpers.reducePathDescriptorToPath(pathDescriptorArg),
+      {
+        couldBeFilePath: true,
+      }
     );
     this.name = pathDescriptorArg.path!;
   }