Compare commits

..

39 Commits

Author SHA1 Message Date
9801e15c32 3.3.2 2024-11-24 20:02:41 +01:00
cbfdd8e123 fix(documentation): Updated keywords and description for clarity and consistency. 2024-11-24 20:02:40 +01:00
138c38ee30 3.3.1 2024-11-24 19:59:37 +01:00
a1e449cf94 fix(File): Fixed issue with file restore metadata operations. 2024-11-24 19:59:37 +01:00
aa9a2e9220 3.3.0 2024-11-24 19:56:13 +01:00
154854dc21 feat(core): Enhanced directory handling and file restoration from trash 2024-11-24 19:56:12 +01:00
8e9041fbbf 3.2.2 2024-11-24 03:05:10 +01:00
16a82ac50a fix(core): Refactor Bucket class for improved error handling 2024-11-24 03:05:10 +01:00
0b396f19cf 3.2.1 2024-11-24 02:28:48 +01:00
6ab77ece6e fix(metadata): Fix metadata handling for deleted files 2024-11-24 02:28:48 +01:00
b7a1f2087c Merge pull request 'fix: use overwrite to make metadata files work' (#2) from fix/smartbucket-trash into master
Reviewed-on: #2
2024-11-24 01:27:58 +00:00
b0d41fa9a0 3.2.0 2024-11-24 02:25:08 +01:00
34082c38a7 feat(bucket): Enhanced SmartBucket with trash management and metadata handling 2024-11-24 02:25:08 +01:00
8d160cefb0 fix: use overwrite to make metadata files work
During a delete the metadata file is updated. As the overwrite property was not set, the metadata
couldn't be updated and caused issues.
2024-11-18 21:08:39 +00:00
cec9c07b7c 3.1.0 2024-11-18 15:07:47 +01:00
383a5204f4 feat(file): Added functionality to retrieve magic bytes from files and detect file types using magic bytes. 2024-11-18 15:07:46 +01:00
c7f0c97341 3.0.24 2024-11-18 11:24:11 +01:00
e7f60465ff fix(metadata): Fix metadata handling to address type assertion and data retrieval. 2024-11-18 11:24:11 +01:00
7db4d24817 3.0.23 2024-10-16 10:27:27 +02:00
dc599585b8 fix(dependencies): Update package dependencies for improved functionality and security. 2024-10-16 10:27:27 +02:00
a22e32cd32 3.0.22 2024-07-28 12:46:39 +02:00
4647181807 fix(dependencies): Update dependencies and improve bucket retrieval logging 2024-07-28 12:46:39 +02:00
99c3935d0c 3.0.21 2024-07-04 18:39:28 +02:00
05523dc7a1 fix(test): Update endpoint configuration in tests to use environment variable 2024-07-04 18:39:27 +02:00
dc99cfa229 3.0.20 2024-06-19 18:28:53 +02:00
23f8dc55d0 fix(core): update 2024-06-19 18:28:52 +02:00
ffaf0fc97a 3.0.19 2024-06-18 18:44:59 +02:00
2a0425ff54 fix(delete functions): ensure more consistency between methods and trash behaviour 2024-06-18 18:44:58 +02:00
9adcdee0a0 3.0.18 2024-06-17 20:00:58 +02:00
786f8d4365 fix(core): update 2024-06-17 20:00:57 +02:00
67244ba5cf 3.0.17 2024-06-17 19:57:56 +02:00
a9bb31c2a2 fix(core): update 2024-06-17 19:57:56 +02:00
bd8b05920f 3.0.16 2024-06-17 16:01:36 +02:00
535d9f8520 fix(core): update 2024-06-17 16:01:35 +02:00
8401fe1c0c 3.0.15 2024-06-11 17:21:22 +02:00
08c3f674bf fix(core): update 2024-06-11 17:21:22 +02:00
df0a439def 3.0.14 2024-06-11 17:20:49 +02:00
7245b49c31 fix(core): update 2024-06-11 17:20:48 +02:00
4b70edb947 finish trash 2024-06-10 16:47:20 +02:00
20 changed files with 5390 additions and 2123 deletions

124
changelog.md Normal file
View File

@ -0,0 +1,124 @@
# 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
- Ensured metadata is correctly stored and managed when files are deleted into the trash.
## 2024-11-24 - 3.2.0 - feat(bucket)
Enhanced SmartBucket with trash management and metadata handling
- Added functionality to move files to a trash directory.
- Introduced methods to handle file metadata more robustly.
- Implemented a method to clean all contents from a bucket.
- Enhanced directory retrieval to handle non-existent directories with options.
- Improved handling of file paths and metadata within the storage system.
## 2024-11-18 - 3.1.0 - feat(file)
Added functionality to retrieve magic bytes from files and detect file types using magic bytes.
- Introduced method `getMagicBytes` in `File` and `Bucket` classes to retrieve a specific number of bytes from a file.
- Enhanced file type detection by utilizing magic bytes in `MetaData` class.
- Updated dependencies for better performance and compatibility.
## 2024-11-18 - 3.0.24 - fix(metadata)
Fix metadata handling to address type assertion and data retrieval.
- Fixed type assertion issues in `MetaData` class properties with type non-null assertions.
- Corrected the handling of JSON data retrieval in `MetaData.storeCustomMetaData` function.
## 2024-10-16 - 3.0.23 - fix(dependencies)
Update package dependencies for improved functionality and security.
- Updated @aws-sdk/client-s3 to version ^3.670.0 for enhanced S3 client capabilities.
- Updated @push.rocks/smartstream to version ^3.2.4.
- Updated the dev dependency @push.rocks/tapbundle to version ^5.3.0.
## 2024-07-28 - 3.0.22 - fix(dependencies)
Update dependencies and improve bucket retrieval logging
- Updated @aws-sdk/client-s3 to ^3.620.0
- Updated @git.zone/tsbuild to ^2.1.84
- Updated @git.zone/tsrun to ^1.2.49
- Updated @push.rocks/smartpromise to ^4.0.4
- Updated @tsclass/tsclass to ^4.1.2
- Added a log for when a bucket is not found by name in getBucketByName method
## 2024-07-04 - 3.0.21 - fix(test)
Update endpoint configuration in tests to use environment variable
- Modified `qenv.yml` to include `S3_ENDPOINT` as a required environment variable.
- Updated test files to fetch `S3_ENDPOINT` from environment instead of hardcoding.
## 2024-06-19 - 3.0.20 - Fix and Stability Updates
Improved overall stability and consistency.
## 2024-06-18 - 3.0.18 - Delete Functions Consistency
Ensured more consistency between delete methods and trash behavior.
## 2024-06-17 - 3.0.17 to 3.0.16 - Fix and Update
Routine updates and fixes performed.
## 2024-06-11 - 3.0.15 to 3.0.14 - Fix and Update
Routine updates and fixes performed.
## 2024-06-10 - 3.0.13 - Trash Feature Completion
Finished work on trash feature.
## 2024-06-09 - 3.0.12 - Fix and Update
Routine updates and fixes performed.
## 2024-06-08 - 3.0.11 to 3.0.10 - Fix and Update
Routine updates and fixes performed.
## 2024-06-03 - 3.0.10 - Fix and Update
Routine updates and fixes performed.
## 2024-05-29 - 3.0.9 - Update Description
Updated project description.
## 2024-05-27 - 3.0.8 to 3.0.6 - Pathing and Core Updates
Routine updates and fixes performed.
- S3 paths' pathing differences now correctly handled with a reducePath method.
## 2024-05-21 - 3.0.5 to 3.0.4 - Fix and Update
Routine updates and fixes performed.
## 2024-05-17 - 3.0.3 to 3.0.2 - Fix and Update
Routine updates and fixes performed.
## 2024-05-17 - 3.0.0 - Major Release
Introduced breaking changes in core and significant improvements.
## 2024-05-05 - 2.0.5 - Breaking Changes
Introduced breaking changes in core functionality.
## 2024-04-14 - 2.0.4 - TSConfig Update
Updated TypeScript configuration.
## 2024-01-01 - 2.0.2 - Organization Scheme Update
Switched to the new organizational scheme.

View File

@ -8,28 +8,32 @@
"githost": "code.foss.global", "githost": "code.foss.global",
"gitscope": "push.rocks", "gitscope": "push.rocks",
"gitrepo": "smartbucket", "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", "npmPackagename": "@push.rocks/smartbucket",
"license": "MIT", "license": "MIT",
"keywords": [ "keywords": [
"TypeScript", "TypeScript",
"cloud storage", "cloud storage",
"object storage", "object storage",
"bucket creation", "bucket management",
"file management", "file operations",
"directory management", "directory management",
"data streaming", "data streaming",
"multi-cloud", "multi-cloud",
"API",
"unified storage",
"S3", "S3",
"minio", "minio",
"API",
"unified storage",
"file locking", "file locking",
"metadata", "metadata management",
"buffer handling", "buffer handling",
"access key", "access control",
"secret key", "cloud agnostic",
"cloud agnostic" "data streaming",
"file transfer",
"data management",
"streaming",
"environment configuration"
] ]
} }
}, },

4
package-lock.json generated
View File

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

View File

@ -1,7 +1,7 @@
{ {
"name": "@push.rocks/smartbucket", "name": "@push.rocks/smartbucket",
"version": "3.0.13", "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", "main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module", "type": "module",
@ -12,21 +12,22 @@
"build": "(tsbuild --web --allowimplicitany)" "build": "(tsbuild --web --allowimplicitany)"
}, },
"devDependencies": { "devDependencies": {
"@git.zone/tsbuild": "^2.1.80", "@git.zone/tsbuild": "^2.1.84",
"@git.zone/tsrun": "^1.2.46", "@git.zone/tsrun": "^1.2.49",
"@git.zone/tstest": "^1.0.90", "@git.zone/tstest": "^1.0.90",
"@push.rocks/qenv": "^6.0.5", "@push.rocks/qenv": "^6.1.0",
"@push.rocks/tapbundle": "^5.0.23" "@push.rocks/tapbundle": "^5.5.3"
}, },
"dependencies": { "dependencies": {
"@push.rocks/smartmime": "^2.0.2", "@aws-sdk/client-s3": "^3.699.0",
"@push.rocks/smartmime": "^2.0.4",
"@push.rocks/smartpath": "^5.0.18", "@push.rocks/smartpath": "^5.0.18",
"@push.rocks/smartpromise": "^4.0.3", "@push.rocks/smartpromise": "^4.0.4",
"@push.rocks/smartrx": "^3.0.7", "@push.rocks/smartrx": "^3.0.7",
"@push.rocks/smartstream": "^3.0.44", "@push.rocks/smartstream": "^3.2.5",
"@push.rocks/smartstring": "^4.0.15",
"@push.rocks/smartunique": "^3.0.9", "@push.rocks/smartunique": "^3.0.9",
"@tsclass/tsclass": "^4.0.55", "@tsclass/tsclass": "^4.1.2"
"minio": "^8.0.0"
}, },
"private": false, "private": false,
"files": [ "files": [
@ -48,21 +49,25 @@
"TypeScript", "TypeScript",
"cloud storage", "cloud storage",
"object storage", "object storage",
"bucket creation", "bucket management",
"file management", "file operations",
"directory management", "directory management",
"data streaming", "data streaming",
"multi-cloud", "multi-cloud",
"API",
"unified storage",
"S3", "S3",
"minio", "minio",
"API",
"unified storage",
"file locking", "file locking",
"metadata", "metadata management",
"buffer handling", "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", "homepage": "https://code.foss.global/push.rocks/smartbucket",
"repository": { "repository": {

5835
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -1,3 +1,4 @@
required: required:
- S3_KEY - S3_KEY
- S3_SECRET - S3_SECRET
- S3_ENDPOINT

305
readme.md
View File

@ -1,41 +1,44 @@
```markdown
# @push.rocks/smartbucket # @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 ## 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 ```bash
npm install @push.rocks/smartbucket --save 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 ## 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 ### Table of Contents
1. [Setting Up](#setting-up) 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) - [Uploading Files](#uploading-files)
- [Downloading Files](#downloading-files) - [Downloading Files](#downloading-files)
- [Deleting Files](#deleting-files)
- [Streaming Files](#streaming-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) - [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 ### 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 ```typescript
import { import {
@ -49,264 +52,200 @@ const mySmartBucket = new SmartBucket({
accessKey: "yourAccessKey", accessKey: "yourAccessKey",
accessSecret: "yourSecretKey", accessSecret: "yourSecretKey",
endpoint: "yourEndpointURL", 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 ```typescript
async function createBucket(bucketName: string) { async function createBucket(bucketName: string) {
try { try {
const myBucket: Bucket = await mySmartBucket.createBucket(bucketName); const newBucket: Bucket = await mySmartBucket.createBucket(bucketName);
console.log(`Bucket ${bucketName} created successfully.`); console.log(`Bucket ${bucketName} created successfully.`);
} catch (error) { } catch (error) {
console.error("Error creating bucket:", 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 #### Uploading Files
To upload an object to a bucket: To upload a file to a bucket, use the `fastPut` method:
```typescript ```typescript
async function uploadFile(bucketName: string, filePath: string, fileContent: Buffer | string) { 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}`); 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 #### Downloading Files
To download an object: Retrieve files using the `fastGet` method:
```typescript ```typescript
async function downloadFile(bucketName: string, filePath: string) { 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 #### 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 ```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 ```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 ```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 ```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 ### Advanced Features
#### Bucket Policies #### 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 ```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 ```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 ## License and Legal Information

0
test/helpers/prepare.ts Normal file
View File

7
test/test.metadata.ts Normal file
View File

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

78
test/test.trash.ts Normal file
View File

@ -0,0 +1,78 @@
import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
import { jestExpect } from '@push.rocks/tapbundle/node';
import { Qenv } from '@push.rocks/qenv';
import * as smartbucket from '../ts/index.js';
const testQenv = new Qenv('./', './.nogit/');
let testSmartbucket: smartbucket.SmartBucket;
let myBucket: smartbucket.Bucket;
let baseDirectory: smartbucket.Directory;
tap.test('should create a valid smartbucket', async () => {
testSmartbucket = new smartbucket.SmartBucket({
accessKey: await testQenv.getEnvVarOnDemandStrict('S3_ACCESSKEY'),
accessSecret: await testQenv.getEnvVarOnDemandStrict('S3_ACCESSSECRET'),
endpoint: await testQenv.getEnvVarOnDemandStrict('S3_ENDPOINT'),
});
expect(testSmartbucket).toBeInstanceOf(smartbucket.SmartBucket);
myBucket = await testSmartbucket.getBucketByNameStrict(await testQenv.getEnvVarOnDemandStrict('S3_BUCKET'),);
expect(myBucket).toBeInstanceOf(smartbucket.Bucket);
expect(myBucket.name).toEqual('test-pushrocks-smartbucket');
});
tap.test('should clean all contents', async () => {
await myBucket.cleanAllContents();
expect(await myBucket.fastExists({ path: 'hithere/socool.txt' })).toBeFalse();
expect(await myBucket.fastExists({ path: 'trashtest/trashme.txt' })).toBeFalse();
});
tap.test('should delete a file into the normally', async () => {
const path = 'trashtest/trashme.txt';
const file = await myBucket.fastPutStrict({
path,
contents: 'I\'m in the trash test content!',
});
const fileMetadata = await (await file.getMetaData()).metadataFile.getContents();
console.log(fileMetadata.toString());
expect(await file.getMetaData().then((meta) => meta.metadataFile.getJsonData())).toEqual({});
await file.delete({ mode: 'permanent' });
expect((await (await myBucket.getBaseDirectory()).listFiles()).length).toEqual(0);
expect((await (await myBucket.getBaseDirectory()).listDirectories()).length).toEqual(0);
});
tap.test('should put a file into the trash', async () => {
const path = 'trashtest/trashme.txt';
const file = await myBucket.fastPutStrict({
path,
contents: 'I\'m in the trash test content!',
});
const fileMetadata = await (await file.getMetaData()).metadataFile.getContents();
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({
custom_recycle: {
deletedAt: jestExpect.any(Number),
originalPath: "trashtest/trashme.txt",
},
});
});
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();

View File

@ -11,24 +11,28 @@ let baseDirectory: smartbucket.Directory;
tap.test('should create a valid smartbucket', async () => { tap.test('should create a valid smartbucket', async () => {
testSmartbucket = new smartbucket.SmartBucket({ testSmartbucket = new smartbucket.SmartBucket({
accessKey: await testQenv.getEnvVarOnDemand('S3_KEY'), accessKey: await testQenv.getEnvVarOnDemandStrict('S3_ACCESSKEY'),
accessSecret: await testQenv.getEnvVarOnDemand('S3_SECRET'), accessSecret: await testQenv.getEnvVarOnDemandStrict('S3_ACCESSSECRET'),
endpoint: 's3.eu-central-1.wasabisys.com', endpoint: await testQenv.getEnvVarOnDemandStrict('S3_ENDPOINT'),
}); });
expect(testSmartbucket).toBeInstanceOf(smartbucket.SmartBucket);
myBucket = await testSmartbucket.getBucketByNameStrict(await testQenv.getEnvVarOnDemandStrict('S3_BUCKET'),);
expect(myBucket).toBeInstanceOf(smartbucket.Bucket);
expect(myBucket.name).toEqual('test-pushrocks-smartbucket');
});
tap.test('should clean all contents', async () => {
await myBucket.cleanAllContents();
expect(await myBucket.fastExists({ path: 'hithere/socool.txt' })).toBeFalse();
expect(await myBucket.fastExists({ path: 'trashtest/trashme.txt' })).toBeFalse();
}); });
tap.skip.test('should create testbucket', async () => { tap.skip.test('should create testbucket', async () => {
// await testSmartbucket.createBucket('testzone'); // await testSmartbucket.createBucket('testzone2');
}); });
tap.skip.test('should remove testbucket', async () => { tap.skip.test('should remove testbucket', async () => {
// await testSmartbucket.removeBucket('testzone'); // await testSmartbucket.removeBucket('testzone2');
});
tap.test('should get a bucket', async () => {
myBucket = await testSmartbucket.getBucketByName('testzone');
expect(myBucket).toBeInstanceOf(smartbucket.Bucket);
expect(myBucket.name).toEqual('testzone');
}); });
// Fast operations // Fast operations
@ -43,9 +47,12 @@ tap.test('should get data in bucket', async () => {
const fileString = await myBucket.fastGet({ const fileString = await myBucket.fastGet({
path: 'hithere/socool.txt', path: 'hithere/socool.txt',
}); });
const fileStringStream = await myBucket.fastGetStream({ const fileStringStream = await myBucket.fastGetStream(
{
path: 'hithere/socool.txt', path: 'hithere/socool.txt',
}, 'nodestream'); },
'nodestream'
);
console.log(fileString); console.log(fileString);
}); });
@ -99,8 +106,9 @@ tap.test('should get base directory', async () => {
tap.test('should correctly build paths for sub directories', async () => { tap.test('should correctly build paths for sub directories', async () => {
const dir4 = await baseDirectory.getSubDirectoryByName('dir3/dir4'); const dir4 = await baseDirectory.getSubDirectoryByName('dir3/dir4');
expect(dir4).toBeInstanceOf(smartbucket.Directory); expect(dir4).toBeInstanceOf(smartbucket.Directory);
const dir4BasePath = dir4.getBasePath(); const dir4BasePath = dir4?.getBasePath();
console.log(dir4BasePath); console.log(dir4BasePath);
expect(dir4BasePath).toEqual('dir3/dir4/');
}); });
tap.test('clean up directory style tests', async () => { tap.test('clean up directory style tests', async () => {

View File

@ -1,8 +1,8 @@
/** /**
* autocreated commitinfo by @pushrocks/commitinfo * autocreated commitinfo by @push.rocks/commitinfo
*/ */
export const commitinfo = { export const commitinfo = {
name: '@push.rocks/smartbucket', name: '@push.rocks/smartbucket',
version: '3.0.13', 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.'
} }

View File

@ -1,33 +1,43 @@
// classes.bucket.ts
import * as plugins from './plugins.js'; import * as plugins from './plugins.js';
import * as helpers from './helpers.js'; import * as helpers from './helpers.js';
import * as interfaces from './interfaces.js'; import * as interfaces from './interfaces.js';
import { SmartBucket } from './classes.smartbucket.js'; import { SmartBucket } from './classes.smartbucket.js';
import { Directory } from './classes.directory.js'; import { Directory } from './classes.directory.js';
import { File } from './classes.file.js'; import { File } from './classes.file.js';
import { Trash } from './classes.trash.js';
/**
* The bucket class exposes the basic functionality of a bucket.
* The functions of the bucket alone are enough to
* operate in S3 basic fashion on blobs of data.
*/
export class Bucket { export class Bucket {
public static async getBucketByName(smartbucketRef: SmartBucket, bucketNameArg: string) { public static async getBucketByName(smartbucketRef: SmartBucket, bucketNameArg: string) {
const buckets = await smartbucketRef.minioClient.listBuckets(); const command = new plugins.s3.ListBucketsCommand({});
const foundBucket = buckets.find((bucket) => { const buckets = await smartbucketRef.s3Client.send(command);
return bucket.name === bucketNameArg; const foundBucket = buckets.Buckets!.find((bucket) => bucket.Name === bucketNameArg);
});
if (foundBucket) { if (foundBucket) {
console.log(`bucket with name ${bucketNameArg} exists.`); console.log(`bucket with name ${bucketNameArg} exists.`);
console.log(`Taking this as base for new Bucket instance`); console.log(`Taking this as base for new Bucket instance`);
return new this(smartbucketRef, bucketNameArg); return new this(smartbucketRef, bucketNameArg);
} else { } else {
console.log(`did not find bucket by name: ${bucketNameArg}`);
return null; return null;
} }
} }
public static async createBucketByName(smartbucketRef: SmartBucket, bucketName: string) { public static async createBucketByName(smartbucketRef: SmartBucket, bucketName: string) {
await smartbucketRef.minioClient.makeBucket(bucketName, 'ams3').catch((e) => console.log(e)); const command = new plugins.s3.CreateBucketCommand({ Bucket: bucketName });
await smartbucketRef.s3Client.send(command).catch((e) => console.log(e));
return new Bucket(smartbucketRef, bucketName); return new Bucket(smartbucketRef, bucketName);
} }
public static async removeBucketByName(smartbucketRef: SmartBucket, bucketName: string) { public static async removeBucketByName(smartbucketRef: SmartBucket, bucketName: string) {
await smartbucketRef.minioClient.removeBucket(bucketName).catch((e) => console.log(e)); const command = new plugins.s3.DeleteBucketCommand({ Bucket: bucketName });
await smartbucketRef.s3Client.send(command).catch((e) => console.log(e));
} }
public smartbucketRef: SmartBucket; public smartbucketRef: SmartBucket;
@ -42,16 +52,28 @@ export class Bucket {
* gets the base directory of the bucket * gets the base directory of the bucket
*/ */
public async getBaseDirectory(): Promise<Directory> { public async getBaseDirectory(): Promise<Directory> {
return new Directory(this, null, ''); return new Directory(this, null!, '');
} }
public async getDirectoryFromPath(pathDescriptorArg: interfaces.IPathDecriptor): Promise<Directory> { /**
* gets the trash directory
*/
public async getTrash(): Promise<Trash> {
const trash = new Trash(this);
return trash;
}
public async getDirectoryFromPath(
pathDescriptorArg: interfaces.IPathDecriptor
): Promise<Directory> {
if (!pathDescriptorArg.path && !pathDescriptorArg.directory) { if (!pathDescriptorArg.path && !pathDescriptorArg.directory) {
return this.getBaseDirectory(); return this.getBaseDirectory();
} }
let checkPath = await helpers.reducePathDescriptorToPath(pathDescriptorArg); const checkPath = await helpers.reducePathDescriptorToPath(pathDescriptorArg);
const baseDirectory = await this.getBaseDirectory(); const baseDirectory = await this.getBaseDirectory();
return await baseDirectory.getSubDirectoryByName(checkPath); return await baseDirectory.getSubDirectoryByNameStrict(checkPath, {
getEmptyDirectory: true,
});
} }
// =============== // ===============
@ -61,33 +83,34 @@ export class Bucket {
/** /**
* store file * store file
*/ */
public async fastPut(optionsArg: { public async fastPut(
path: string; optionsArg: interfaces.IPathDecriptor & {
contents: string | Buffer; contents: string | Buffer;
overwrite?: boolean; overwrite?: boolean;
}): Promise<File> { }
): Promise<File | null> {
try { try {
const reducedPath = await helpers.reducePathDescriptorToPath({ const reducedPath = await helpers.reducePathDescriptorToPath(optionsArg);
path: optionsArg.path,
})
// Check if the object already exists
const exists = await this.fastExists({ path: reducedPath }); const exists = await this.fastExists({ path: reducedPath });
if (exists && !optionsArg.overwrite) { 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) { } else if (exists && optionsArg.overwrite) {
console.log(`Overwriting existing object at path '${reducedPath}' in bucket '${this.name}'.`); console.log(
`Overwriting existing object at path '${reducedPath}' in bucket '${this.name}'.`
);
} else { } else {
console.log(`Creating new object at path '${reducedPath}' in bucket '${this.name}'.`); console.log(`Creating new object at path '${reducedPath}' in bucket '${this.name}'.`);
} }
// Proceed with putting the object const command = new plugins.s3.PutObjectCommand({
const streamIntake = new plugins.smartstream.StreamIntake(); Bucket: this.name,
const putPromise = this.smartbucketRef.minioClient.putObject(this.name, reducedPath, streamIntake); Key: reducedPath,
streamIntake.pushData(optionsArg.contents); Body: optionsArg.contents,
streamIntake.signalEnd(); });
await putPromise; await this.smartbucketRef.s3Client.send(command);
console.log(`Object '${reducedPath}' has been successfully stored in bucket '${this.name}'.`); console.log(`Object '${reducedPath}' has been successfully stored in bucket '${this.name}'.`);
const parsedPath = plugins.path.parse(reducedPath); const parsedPath = plugins.path.parse(reducedPath);
@ -98,18 +121,26 @@ export class Bucket {
fileName: parsedPath.base, fileName: parsedPath.base,
}); });
} catch (error) { } catch (error) {
console.error(`Error storing object at path '${optionsArg.path}' in bucket '${this.name}':`, error); console.error(
`Error storing object at path '${optionsArg.path}' in bucket '${this.name}':`,
error
);
throw error; throw error;
} }
} }
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 * get file
*/ */
public async fastGet(optionsArg: { public async fastGet(optionsArg: { path: string }): Promise<Buffer> {
path: string
}): Promise<Buffer> {
const done = plugins.smartpromise.defer(); const done = plugins.smartpromise.defer();
let completeFile: Buffer; let completeFile: Buffer;
const replaySubject = await this.fastGetReplaySubject(optionsArg); const replaySubject = await this.fastGetReplaySubject(optionsArg);
@ -130,7 +161,7 @@ export class Bucket {
}, },
}); });
await done.promise; await done.promise;
return completeFile; return completeFile!;
} }
/** /**
@ -142,10 +173,16 @@ export class Bucket {
public async fastGetReplaySubject(optionsArg: { public async fastGetReplaySubject(optionsArg: {
path: string; path: string;
}): Promise<plugins.smartrx.rxjs.ReplaySubject<Buffer>> { }): Promise<plugins.smartrx.rxjs.ReplaySubject<Buffer>> {
const fileStream = await this.smartbucketRef.minioClient const command = new plugins.s3.GetObjectCommand({
.getObject(this.name, optionsArg.path) Bucket: this.name,
.catch((e) => console.log(e)); Key: optionsArg.path,
});
const response = await this.smartbucketRef.s3Client.send(command);
const replaySubject = new plugins.smartrx.rxjs.ReplaySubject<Buffer>(); const replaySubject = new plugins.smartrx.rxjs.ReplaySubject<Buffer>();
// Convert the stream to a format that supports piping
const stream = response.Body as any; // SdkStreamMixin includes readable stream
if (typeof stream.pipe === 'function') {
const duplexStream = new plugins.smartstream.SmartDuplex<Buffer, void>({ const duplexStream = new plugins.smartstream.SmartDuplex<Buffer, void>({
writeFunction: async (chunk) => { writeFunction: async (chunk) => {
replaySubject.next(chunk); replaySubject.next(chunk);
@ -154,61 +191,59 @@ export class Bucket {
finalFunction: async (cb) => { finalFunction: async (cb) => {
replaySubject.complete(); replaySubject.complete();
return; return;
} },
}); });
if (!fileStream) { stream.pipe(duplexStream);
return null;
} }
const smartstream = new plugins.smartstream.StreamWrapper([
fileStream,
duplexStream,
]);
smartstream.run();
return replaySubject; return replaySubject;
} }
public fastGetStream(optionsArg: { public fastGetStream(
optionsArg: {
path: string; path: string;
}, typeArg: 'webstream'): Promise<ReadableStream> },
public async fastGetStream(optionsArg: { typeArg: 'webstream'
): Promise<ReadableStream>;
public async fastGetStream(
optionsArg: {
path: string; path: string;
}, typeArg: 'nodestream'): Promise<plugins.stream.Readable> },
typeArg: 'nodestream'
): Promise<plugins.stream.Readable>;
public async fastGetStream(
optionsArg: { path: string },
typeArg: 'webstream' | 'nodestream' = 'nodestream'
): Promise<ReadableStream | plugins.stream.Readable> {
const command = new plugins.s3.GetObjectCommand({
Bucket: this.name,
Key: optionsArg.path,
});
const response = await this.smartbucketRef.s3Client.send(command);
const stream = response.Body as any; // SdkStreamMixin includes readable stream
/**
* fastGetStream
* @param optionsArg
* @returns
*/
public async fastGetStream(optionsArg: { path: string; }, typeArg: 'webstream' | 'nodestream' = 'nodestream'): Promise<ReadableStream | plugins.stream.Readable>{
const fileStream = await this.smartbucketRef.minioClient
.getObject(this.name, optionsArg.path)
.catch((e) => console.log(e));
const duplexStream = new plugins.smartstream.SmartDuplex<Buffer, Buffer>({ const duplexStream = new plugins.smartstream.SmartDuplex<Buffer, Buffer>({
writeFunction: async (chunk) => { writeFunction: async (chunk) => {
return chunk; return chunk;
}, },
finalFunction: async (cb) => { finalFunction: async (cb) => {
return null; return null!;
} },
}); });
if (!fileStream) { if (typeof stream.pipe === 'function') {
return null; stream.pipe(duplexStream);
} }
const smartstream = new plugins.smartstream.StreamWrapper([
fileStream,
duplexStream,
]);
smartstream.run();
if (typeArg === 'nodestream') { if (typeArg === 'nodestream') {
return duplexStream; return duplexStream;
}; }
if (typeArg === 'webstream') { if (typeArg === 'webstream') {
return (await duplexStream.getWebStreams()).readable; return (await duplexStream.getWebStreams()).readable;
} }
throw new Error('unknown typeArg');
} }
/** /**
@ -221,37 +256,41 @@ export class Bucket {
overwrite?: boolean; overwrite?: boolean;
}): Promise<void> { }): Promise<void> {
try { try {
// Check if the object already exists
const exists = await this.fastExists({ path: optionsArg.path }); const exists = await this.fastExists({ path: optionsArg.path });
if (exists && !optionsArg.overwrite) { if (exists && !optionsArg.overwrite) {
console.error(`Object already exists at path '${optionsArg.path}' in bucket '${this.name}'.`); console.error(
`Object already exists at path '${optionsArg.path}' in bucket '${this.name}'.`
);
return; return;
} else if (exists && optionsArg.overwrite) { } else if (exists && optionsArg.overwrite) {
console.log(`Overwriting existing object at path '${optionsArg.path}' in bucket '${this.name}'.`); console.log(
`Overwriting existing object at path '${optionsArg.path}' in bucket '${this.name}'.`
);
} else { } else {
console.log(`Creating new object at path '${optionsArg.path}' in bucket '${this.name}'.`); console.log(`Creating new object at path '${optionsArg.path}' in bucket '${this.name}'.`);
} }
const streamIntake = await plugins.smartstream.StreamIntake.fromStream<Uint8Array>(optionsArg.readableStream); const command = new plugins.s3.PutObjectCommand({
Bucket: this.name,
Key: optionsArg.path,
Body: optionsArg.readableStream,
Metadata: optionsArg.nativeMetadata,
});
await this.smartbucketRef.s3Client.send(command);
// Proceed with putting the object console.log(
await this.smartbucketRef.minioClient.putObject( `Object '${optionsArg.path}' has been successfully stored in bucket '${this.name}'.`
this.name,
optionsArg.path,
streamIntake,
null,
null, // TODO: Add support for custom metadata once proper support is in minio.
); );
console.log(`Object '${optionsArg.path}' has been successfully stored in bucket '${this.name}'.`);
} catch (error) { } catch (error) {
console.error(`Error storing object at path '${optionsArg.path}' in bucket '${this.name}':`, error); console.error(
`Error storing object at path '${optionsArg.path}' in bucket '${this.name}':`,
error
);
throw error; throw error;
} }
} }
public async fastCopy(optionsArg: { public async fastCopy(optionsArg: {
sourcePath: string; sourcePath: string;
destinationPath?: string; destinationPath?: string;
@ -263,28 +302,29 @@ export class Bucket {
const targetBucketName = optionsArg.targetBucket ? optionsArg.targetBucket.name : this.name; const targetBucketName = optionsArg.targetBucket ? optionsArg.targetBucket.name : this.name;
// Retrieve current object information to use in copy conditions // Retrieve current object information to use in copy conditions
const currentObjInfo = await this.smartbucketRef.minioClient.statObject( const currentObjInfo = await this.smartbucketRef.s3Client.send(
targetBucketName, new plugins.s3.HeadObjectCommand({
optionsArg.sourcePath Bucket: this.name,
Key: optionsArg.sourcePath,
})
); );
// Setting up copy conditions
const copyConditions = new plugins.minio.CopyConditions();
// Prepare new metadata // Prepare new metadata
const newNativeMetadata = { const newNativeMetadata = {
...(optionsArg.deleteExistingNativeMetadata ? {} : currentObjInfo.metaData), ...(optionsArg.deleteExistingNativeMetadata ? {} : currentObjInfo.Metadata),
...optionsArg.nativeMetadata, ...optionsArg.nativeMetadata,
}; };
// Define the copy operation as a Promise // Define the copy operation
// TODO: check on issue here: https://github.com/minio/minio-js/issues/1286 const copySource = `${this.name}/${optionsArg.sourcePath}`;
await this.smartbucketRef.minioClient.copyObject( const command = new plugins.s3.CopyObjectCommand({
this.name, Bucket: targetBucketName,
optionsArg.sourcePath, CopySource: copySource,
`/${targetBucketName}/${optionsArg.destinationPath || optionsArg.sourcePath}`, Key: optionsArg.destinationPath || optionsArg.sourcePath,
copyConditions Metadata: newNativeMetadata,
); MetadataDirective: optionsArg.deleteExistingNativeMetadata ? 'REPLACE' : 'COPY',
});
await this.smartbucketRef.s3Client.send(command);
} catch (err) { } catch (err) {
console.error('Error updating metadata:', err); console.error('Error updating metadata:', err);
throw err; // rethrow to allow caller to handle throw err; // rethrow to allow caller to handle
@ -301,56 +341,68 @@ export class Bucket {
overwrite?: boolean; overwrite?: boolean;
}): Promise<void> { }): Promise<void> {
try { try {
// Check if the destination object already exists
const destinationBucket = optionsArg.targetBucket || this; const destinationBucket = optionsArg.targetBucket || this;
const exists = await destinationBucket.fastExists({ path: optionsArg.destinationPath }); const exists = await destinationBucket.fastExists({
path: optionsArg.destinationPath,
});
if (exists && !optionsArg.overwrite) { if (exists && !optionsArg.overwrite) {
console.error(`Object already exists at destination path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`); console.error(
`Object already exists at destination path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`
);
return; return;
} else if (exists && optionsArg.overwrite) { } else if (exists && optionsArg.overwrite) {
console.log(`Overwriting existing object at destination path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`); console.log(
`Overwriting existing object at destination path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`
);
} else { } else {
console.log(`Moving object to path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`); console.log(
`Moving object to path '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`
);
} }
// Proceed with copying the object to the new path
await this.fastCopy(optionsArg); await this.fastCopy(optionsArg);
// Remove the original object after successful copy
await this.fastRemove({ path: optionsArg.sourcePath }); await this.fastRemove({ path: optionsArg.sourcePath });
console.log(`Object '${optionsArg.sourcePath}' has been successfully moved to '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`); console.log(
`Object '${optionsArg.sourcePath}' has been successfully moved to '${optionsArg.destinationPath}' in bucket '${destinationBucket.name}'.`
);
} catch (error) { } catch (error) {
console.error(`Error moving object from '${optionsArg.sourcePath}' to '${optionsArg.destinationPath}':`, error); console.error(
`Error moving object from '${optionsArg.sourcePath}' to '${optionsArg.destinationPath}':`,
error
);
throw error; throw error;
} }
} }
/** /**
* removeObject * removeObject
*/ */
public async fastRemove(optionsArg: { public async fastRemove(optionsArg: { path: string }) {
path: string; const command = new plugins.s3.DeleteObjectCommand({
}) { Bucket: this.name,
await this.smartbucketRef.minioClient.removeObject(this.name, optionsArg.path); Key: optionsArg.path,
});
await this.smartbucketRef.s3Client.send(command);
} }
/** /**
* check wether file exists * check whether file exists
* @param optionsArg * @param optionsArg
* @returns * @returns
*/ */
public async fastExists(optionsArg: { public async fastExists(optionsArg: { path: string }): Promise<boolean> {
path: string;
}): Promise<boolean> {
try { try {
await this.smartbucketRef.minioClient.statObject(this.name, optionsArg.path); const command = new plugins.s3.HeadObjectCommand({
Bucket: this.name,
Key: optionsArg.path,
});
await this.smartbucketRef.s3Client.send(command);
console.log(`Object '${optionsArg.path}' exists in bucket '${this.name}'.`); console.log(`Object '${optionsArg.path}' exists in bucket '${this.name}'.`);
return true; return true;
} catch (error) { } catch (error: any) {
if (error.code === 'NotFound') { if (error?.name === 'NotFound') {
console.log(`Object '${optionsArg.path}' does not exist in bucket '${this.name}'.`); console.log(`Object '${optionsArg.path}' does not exist in bucket '${this.name}'.`);
return false; return false;
} else { } else {
@ -364,59 +416,111 @@ export class Bucket {
* deletes this bucket * deletes this bucket
*/ */
public async delete() { public async delete() {
await this.smartbucketRef.minioClient.removeBucket(this.name); await this.smartbucketRef.s3Client.send(
new plugins.s3.DeleteBucketCommand({ Bucket: this.name })
);
} }
public async fastStat(pathDescriptor: interfaces.IPathDecriptor) { public async fastStat(pathDescriptor: interfaces.IPathDecriptor) {
let checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor); const checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor);
return this.smartbucketRef.minioClient.statObject(this.name, checkPath); const command = new plugins.s3.HeadObjectCommand({
Bucket: this.name,
Key: checkPath,
});
return this.smartbucketRef.s3Client.send(command);
} }
public async isDirectory(pathDescriptor: interfaces.IPathDecriptor): Promise<boolean> { public async isDirectory(pathDescriptor: interfaces.IPathDecriptor): Promise<boolean> {
let checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor); const checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor);
const command = new plugins.s3.ListObjectsV2Command({
// lets check if the checkPath is a directory Bucket: this.name,
const stream = this.smartbucketRef.minioClient.listObjectsV2(this.name, checkPath, true); Prefix: checkPath,
const done = plugins.smartpromise.defer<boolean>(); Delimiter: '/',
stream.on('data', (dataArg) => { });
stream.destroy(); // Stop the stream early if we find at least one object const { CommonPrefixes } = await this.smartbucketRef.s3Client.send(command);
if (dataArg.prefix.startsWith(checkPath + '/')) { return !!CommonPrefixes && CommonPrefixes.length > 0;
done.resolve(true);
} }
});
stream.on('end', () => {
done.resolve(false);
});
stream.on('error', (err) => {
done.reject(err);
});
return done.promise;
};
public async isFile(pathDescriptor: interfaces.IPathDecriptor): Promise<boolean> { public async isFile(pathDescriptor: interfaces.IPathDecriptor): Promise<boolean> {
let checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor); const checkPath = await helpers.reducePathDescriptorToPath(pathDescriptor);
const command = new plugins.s3.ListObjectsV2Command({
// lets check if the checkPath is a directory Bucket: this.name,
const stream = this.smartbucketRef.minioClient.listObjectsV2(this.name, checkPath, true); Prefix: checkPath,
const done = plugins.smartpromise.defer<boolean>(); Delimiter: '/',
stream.on('data', (dataArg) => { });
stream.destroy(); // Stop the stream early if we find at least one object const { Contents } = await this.smartbucketRef.s3Client.send(command);
if (dataArg.prefix === checkPath) { return !!Contents && Contents.length > 0;
done.resolve(true);
} }
});
stream.on('end', () => { public async getMagicBytes(optionsArg: { path: string; length: number }): Promise<Buffer> {
done.resolve(false); try {
const command = new plugins.s3.GetObjectCommand({
Bucket: this.name,
Key: optionsArg.path,
Range: `bytes=0-${optionsArg.length - 1}`,
}); });
const response = await this.smartbucketRef.s3Client.send(command);
const chunks = [];
const stream = response.Body as any; // SdkStreamMixin includes readable stream
stream.on('error', (err) => { for await (const chunk of stream) {
done.reject(err); chunks.push(chunk);
}); }
return Buffer.concat(chunks);
return done.promise; } catch (error) {
console.error(
`Error retrieving magic bytes from object at path '${optionsArg.path}' in bucket '${this.name}':`,
error
);
throw error;
}
}
public async cleanAllContents(): Promise<void> {
try {
// Define the command type explicitly
const listCommandInput: plugins.s3.ListObjectsV2CommandInput = {
Bucket: this.name,
};
let isTruncated = true;
let continuationToken: string | undefined = undefined;
while (isTruncated) {
// Add the continuation token to the input if present
const listCommand = new plugins.s3.ListObjectsV2Command({
...listCommandInput,
ContinuationToken: continuationToken,
});
// Explicitly type the response
const response: plugins.s3.ListObjectsV2Output =
await this.smartbucketRef.s3Client.send(listCommand);
console.log(`Cleaning contents of bucket '${this.name}': Now deleting ${response.Contents?.length} items...`);
if (response.Contents && response.Contents.length > 0) {
// Delete objects in batches, mapping each item to { Key: string }
const deleteCommand = new plugins.s3.DeleteObjectsCommand({
Bucket: this.name,
Delete: {
Objects: response.Contents.map((item) => ({ Key: item.Key! })),
Quiet: true,
},
});
await this.smartbucketRef.s3Client.send(deleteCommand);
}
// Update continuation token and truncation status
isTruncated = response.IsTruncated || false;
continuationToken = response.NextContinuationToken;
}
console.log(`All contents in bucket '${this.name}' have been deleted.`);
} catch (error) {
console.error(`Error cleaning contents of bucket '${this.name}':`, error);
throw error;
}
} }
} }

View File

@ -1,19 +1,22 @@
// classes.directory.ts
import * as plugins from './plugins.js'; import * as plugins from './plugins.js';
import { Bucket } from './classes.bucket.js'; import { Bucket } from './classes.bucket.js';
import { File } from './classes.file.js'; import { File } from './classes.file.js';
import * as helpers from './helpers.js';
export class Directory { export class Directory {
public bucketRef: Bucket; public bucketRef: Bucket;
public parentDirectoryRef: Directory; public parentDirectoryRef: Directory;
public name: string; public name: string;
public tree: string[]; public tree!: string[];
public files: string[]; public files!: string[];
public folders: string[]; public folders!: string[];
constructor(bucketRefArg: Bucket, parentDiretory: Directory, name: string) { constructor(bucketRefArg: Bucket, parentDirectory: Directory, name: string) {
this.bucketRef = bucketRefArg; this.bucketRef = bucketRefArg;
this.parentDirectoryRef = parentDiretory; this.parentDirectoryRef = parentDirectory;
this.name = name; this.name = name;
} }
@ -63,53 +66,66 @@ export class Directory {
* gets a file by name * gets a file by name
*/ */
public async getFile(optionsArg: { public async getFile(optionsArg: {
name: string; path: string;
createWithContents?: string | Buffer; createWithContents?: string | Buffer;
}): Promise<File> { getFromTrash?: boolean;
// check wether the file exists }): Promise<File | null> {
const pathDescriptor = {
directory: this,
path: optionsArg.path,
};
const exists = await this.bucketRef.fastExists({ const exists = await this.bucketRef.fastExists({
path: this.getBasePath() + optionsArg.name, path: await helpers.reducePathDescriptorToPath(pathDescriptor),
}); });
if (!exists && optionsArg.getFromTrash) {
const trash = await this.bucketRef.getTrash();
const trashedFile = await trash.getTrashedFileByOriginalName(pathDescriptor);
return trashedFile;
}
if (!exists && !optionsArg.createWithContents) { if (!exists && !optionsArg.createWithContents) {
return null; return null;
} }
if (!exists && optionsArg.createWithContents) { if (!exists && optionsArg.createWithContents) {
await File.create({ await File.create({
directory: this, directory: this,
name: optionsArg.name, name: optionsArg.path,
contents: optionsArg.createWithContents, contents: optionsArg.createWithContents,
}); });
} }
return new File({ return new File({
directoryRefArg: this, directoryRefArg: this,
fileName: optionsArg.name, fileName: optionsArg.path,
}) });
}
/**
* gets a file strictly
* @param args
* @returns
*/
public async getFileStrict(...args: Parameters<Directory['getFile']>) {
const file = await this.getFile(...args);
if (!file) {
throw new Error(`File not found at path '${args[0].path}'`);
}
return file;
} }
/** /**
* lists all files * lists all files
*/ */
public async listFiles(): Promise<File[]> { public async listFiles(): Promise<File[]> {
const done = plugins.smartpromise.defer(); const command = new plugins.s3.ListObjectsV2Command({
const fileNameStream = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2( Bucket: this.bucketRef.name,
this.bucketRef.name, Prefix: this.getBasePath(),
this.getBasePath(), Delimiter: '/',
false });
); const response = await this.bucketRef.smartbucketRef.s3Client.send(command);
const fileArray: File[] = []; const fileArray: File[] = [];
const duplexStream = new plugins.smartstream.SmartDuplex<plugins.minio.BucketItem, void>({
objectMode: true, response.Contents?.forEach((item) => {
writeFunction: async (bucketItem) => { if (item.Key && !item.Key.endsWith('/')) {
if (bucketItem.prefix) { const subtractedPath = item.Key.replace(this.getBasePath(), '');
return;
}
if (!bucketItem.name) {
return;
}
let subtractedPath = bucketItem.name.replace(this.getBasePath(), '');
if (subtractedPath.startsWith('/')) {
subtractedPath = subtractedPath.substr(1);
}
if (!subtractedPath.includes('/')) { if (!subtractedPath.includes('/')) {
fileArray.push( fileArray.push(
new File({ new File({
@ -118,13 +134,9 @@ export class Directory {
}) })
); );
} }
},
finalFunction: async (tools) => {
done.resolve();
} }
}); });
fileNameStream.pipe(duplexStream);
await done.promise;
return fileArray; return fileArray;
} }
@ -132,70 +144,124 @@ export class Directory {
* lists all folders * lists all folders
*/ */
public async listDirectories(): Promise<Directory[]> { public async listDirectories(): Promise<Directory[]> {
const done = plugins.smartpromise.defer(); try {
const basePath = this.getBasePath(); const command = new plugins.s3.ListObjectsV2Command({
const completeDirStream = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2( Bucket: this.bucketRef.name,
this.bucketRef.name, Prefix: this.getBasePath(),
this.getBasePath(), Delimiter: '/',
false });
); const response = await this.bucketRef.smartbucketRef.s3Client.send(command);
const directoryArray: Directory[] = []; const directoryArray: Directory[] = [];
const duplexStream = new plugins.smartstream.SmartDuplex<plugins.minio.BucketItem, void>({
objectMode: true, if (response.CommonPrefixes) {
writeFunction: async (bucketItem) => { response.CommonPrefixes.forEach((item) => {
if (bucketItem.name) { if (item.Prefix) {
return; const subtractedPath = item.Prefix.replace(this.getBasePath(), '');
} if (subtractedPath.endsWith('/')) {
let subtractedPath = bucketItem.prefix.replace(this.getBasePath(), ''); const dirName = subtractedPath.slice(0, -1);
if (subtractedPath.startsWith('/')) { // Ensure the directory name is not empty (which would indicate the base directory itself)
subtractedPath = subtractedPath.substr(1); if (dirName) {
}
if (subtractedPath.includes('/')) {
const dirName = subtractedPath.split('/')[0];
if (directoryArray.find((directory) => directory.name === dirName)) {
return;
}
directoryArray.push(new Directory(this.bucketRef, this, dirName)); directoryArray.push(new Directory(this.bucketRef, this, dirName));
} }
}, }
finalFunction: async (tools) => {
done.resolve();
} }
}); });
completeDirStream.pipe(duplexStream); }
await done.promise;
return directoryArray; return directoryArray;
} catch (error) {
console.error('Error listing directories:', error);
throw error;
}
} }
/** /**
* gets an array that has all objects with a certain prefix; * gets an array that has all objects with a certain prefix
*/ */
public async getTreeArray() { public async getTreeArray() {
const treeArray = await this.bucketRef.smartbucketRef.minioClient.listObjectsV2( const command = new plugins.s3.ListObjectsV2Command({
this.bucketRef.name, Bucket: this.bucketRef.name,
this.getBasePath(), Prefix: this.getBasePath(),
true Delimiter: '/',
); });
const response = await this.bucketRef.smartbucketRef.s3Client.send(command);
return response.Contents;
} }
/** /**
* gets a sub directory * gets a sub directory by name
*/ */
public async getSubDirectoryByName(dirNameArg: string): Promise<Directory> { public async getSubDirectoryByName(dirNameArg: string, optionsArg: {
const dirNameArray = dirNameArg.split('/'); /**
* 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 getDirectory = async (directoryArg: Directory, dirNameToSearch: string) => { const dirNameArray = dirNameArg.split('/').filter(str => str.trim() !== "");
optionsArg = {
getEmptyDirectory: false,
createWithInitializerFile: false,
...optionsArg,
}
const getDirectory = async (directoryArg: Directory, dirNameToSearch: string, isFinalDirectory: boolean) => {
const directories = await directoryArg.listDirectories(); const directories = await directoryArg.listDirectories();
return directories.find((directory) => { let returnDirectory = directories.find((directory) => {
return directory.name === dirNameToSearch; return directory.name === dirNameToSearch;
}); });
}; if (returnDirectory) {
let wantedDirectory: Directory; return returnDirectory;
for (const dirNameToSearch of dirNameArray) {
const directoryToSearchIn = wantedDirectory ? wantedDirectory : this;
wantedDirectory = await getDirectory(directoryToSearchIn, dirNameToSearch);
} }
return wantedDirectory; if (optionsArg.getEmptyDirectory || optionsArg.createWithInitializerFile) {
returnDirectory = new Directory(this.bucketRef, this, dirNameToSearch);
}
if (isFinalDirectory && optionsArg.createWithInitializerFile) {
returnDirectory?.createEmptyFile('00init.txt');
}
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) {
counter++;
const directoryToSearchIn = wantedDirectory ? wantedDirectory : this;
wantedDirectory = await getDirectory(directoryToSearchIn, dirNameToSearch, counter === dirNameArray.length);
}
return wantedDirectory || null;
}
public async getSubDirectoryByNameStrict(...args: Parameters<Directory['getSubDirectoryByName']>) {
const directory = await this.getSubDirectoryByName(...args);
if (!directory) {
throw new Error(`Directory not found at path '${args[0]}'`);
}
return directory;
} }
/** /**
@ -203,19 +269,20 @@ export class Directory {
*/ */
public async move() { public async move() {
// TODO // TODO
throw new Error('moving a directory is not yet implemented'); throw new Error('Moving a directory is not yet implemented');
} }
/** /**
* creates a file within this directory * creates an empty file within this directory
* @param relativePathArg * @param relativePathArg
*/ */
public async createEmptyFile(relativePathArg: string) { public async createEmptyFile(relativePathArg: string) {
const emtpyFile = await File.create({ const emptyFile = await File.create({
directory: this, directory: this,
name: relativePathArg, name: relativePathArg,
contents: '', contents: '',
}); });
return emptyFile;
} }
// file operations // file operations
@ -235,23 +302,35 @@ export class Directory {
return result; return result;
} }
public fastGetStream(optionsArg: { public fastGetStream(
optionsArg: {
path: string; path: string;
}, typeArg: 'webstream'): Promise<ReadableStream> },
public async fastGetStream(optionsArg: { typeArg: 'webstream'
): Promise<ReadableStream>;
public async fastGetStream(
optionsArg: {
path: string; path: string;
}, typeArg: 'nodestream'): Promise<plugins.stream.Readable> },
typeArg: 'nodestream'
): Promise<plugins.stream.Readable>;
/** /**
* fastGetStream * fastGetStream
* @param optionsArg * @param optionsArg
* @returns * @returns
*/ */
public async fastGetStream(optionsArg: { path: string; }, typeArg: 'webstream' | 'nodestream'): Promise<ReadableStream | plugins.stream.Readable>{ public async fastGetStream(
optionsArg: { path: string },
typeArg: 'webstream' | 'nodestream'
): Promise<ReadableStream | plugins.stream.Readable> {
const path = plugins.path.join(this.getBasePath(), optionsArg.path); const path = plugins.path.join(this.getBasePath(), optionsArg.path);
const result = await this.bucketRef.fastGetStream({ const result = await this.bucketRef.fastGetStream(
path {
}, typeArg as any); path,
},
typeArg as any
);
return result; return result;
} }
@ -271,23 +350,34 @@ export class Directory {
/** /**
* removes a file within the directory * removes a file within the directory
* uses file class to make sure effects for metadata etc. are handled correctly
* @param optionsArg * @param optionsArg
*/ */
public async fastRemove(optionsArg: { path: string }) { public async fastRemove(optionsArg: {
const path = plugins.path.join(this.getBasePath(), optionsArg.path); path: string
await this.bucketRef.fastRemove({ /**
path, * wether the file should be placed into trash. Default is false.
*/
mode?: 'permanent' | 'trash';
}) {
const file = await this.getFileStrict({
path: optionsArg.path,
});
await file.delete({
mode: optionsArg.mode ? optionsArg.mode : 'permanent',
}); });
} }
/** /**
* deletes the directory with all its contents * deletes the directory with all its contents
*/ */
public async delete() { public async delete(optionsArg: {
mode?: 'permanent' | 'trash';
}) {
const deleteDirectory = async (directoryArg: Directory) => { const deleteDirectory = async (directoryArg: Directory) => {
const childDirectories = await directoryArg.listDirectories(); const childDirectories = await directoryArg.listDirectories();
if (childDirectories.length === 0) { if (childDirectories.length === 0) {
console.log('directory empty! Path complete!'); console.log('Directory empty! Path complete!');
} else { } else {
for (const childDir of childDirectories) { for (const childDir of childDirectories) {
await deleteDirectory(childDir); await deleteDirectory(childDir);
@ -295,9 +385,9 @@ export class Directory {
} }
const files = await directoryArg.listFiles(); const files = await directoryArg.listFiles();
for (const file of files) { for (const file of files) {
await directoryArg.fastRemove({ await file.delete({
path: file.name, mode: optionsArg.mode ? optionsArg.mode : 'permanent',
}); })
} }
}; };
await deleteDirectory(this); await deleteDirectory(this);

View File

@ -50,6 +50,10 @@ export class File {
public parentDirectoryRef: Directory; public parentDirectoryRef: Directory;
public name: string; public name: string;
/**
* get the full path to the file
* @returns the full path to the file
*/
public getBasePath(): string { public getBasePath(): string {
return plugins.path.join(this.parentDirectoryRef.getBasePath(), this.name); return plugins.path.join(this.parentDirectoryRef.getBasePath(), this.name);
} }
@ -88,25 +92,24 @@ export class File {
/** /**
* deletes this file * deletes this file
*/ */
public async delete(optionsArg?: { public async delete(optionsArg?: { mode: 'trash' | 'permanent' }) {
mode: 'trash' | 'permanent';
}) {
optionsArg = { optionsArg = {
...{ ...{
mode: 'permanent', mode: 'permanent',
}, },
...optionsArg, ...optionsArg,
} };
if (optionsArg.mode === 'permanent') { if (optionsArg.mode === 'permanent') {
await this.parentDirectoryRef.bucketRef.fastRemove({ await this.parentDirectoryRef.bucketRef.fastRemove({
path: this.getBasePath(), path: this.getBasePath(),
}); });
if (!this.name.endsWith('.metadata')) { if (!this.name.endsWith('.metadata')) {
if (await this.hasMetaData()) {
const metadata = await this.getMetaData(); const metadata = await this.getMetaData();
await metadata.metadataFile.delete(optionsArg); await metadata.metadataFile.delete(optionsArg);
} }
}
} else if (optionsArg.mode === 'trash') { } else if (optionsArg.mode === 'trash') {
const metadata = await this.getMetaData(); const metadata = await this.getMetaData();
await metadata.storeCustomMetaData({ await metadata.storeCustomMetaData({
@ -116,16 +119,44 @@ export class File {
originalPath: this.getBasePath(), originalPath: this.getBasePath(),
}, },
}); });
const trashName = plugins.smartunique.uuid4(); const trash = await this.parentDirectoryRef.bucketRef.getTrash();
const trashDir = await trash.getTrashDir();
await this.move({ await this.move({
directory: await this.parentDirectoryRef.bucketRef.getBaseDirectory(), directory: trashDir,
path: plugins.path.join('trash', trashName), path: await trash.getTrashKeyByOriginalBasePath(this.getBasePath()),
}); });
} }
await this.parentDirectoryRef.listFiles(); 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 * allows locking the file
* @param optionsArg * @param optionsArg
@ -150,7 +181,7 @@ export class File {
}) { }) {
const metadata = await this.getMetaData(); const metadata = await this.getMetaData();
await metadata.removeLock({ await metadata.removeLock({
force: optionsArg?.force, force: optionsArg?.force || false,
}); });
} }
@ -165,16 +196,19 @@ export class File {
await this.parentDirectoryRef.bucketRef.fastPutStream({ await this.parentDirectoryRef.bucketRef.fastPutStream({
path: this.getBasePath(), path: this.getBasePath(),
readableStream: optionsArg.contents, readableStream: optionsArg.contents,
overwrite: true,
}); });
} else if (Buffer.isBuffer(optionsArg.contents)) { } else if (Buffer.isBuffer(optionsArg.contents)) {
await this.parentDirectoryRef.bucketRef.fastPut({ await this.parentDirectoryRef.bucketRef.fastPut({
path: this.getBasePath(), path: this.getBasePath(),
contents: optionsArg.contents, contents: optionsArg.contents,
overwrite: true,
}); });
} else if (typeof optionsArg.contents === 'string') { } else if (typeof optionsArg.contents === 'string') {
await this.parentDirectoryRef.bucketRef.fastPut({ await this.parentDirectoryRef.bucketRef.fastPut({
path: this.getBasePath(), path: this.getBasePath(),
contents: Buffer.from(optionsArg.contents, optionsArg.encoding), contents: Buffer.from(optionsArg.contents, optionsArg.encoding),
overwrite: true,
}); });
} }
} }
@ -183,23 +217,52 @@ export class File {
* moves the file to another directory * moves the file to another directory
*/ */
public async move(pathDescriptorArg: interfaces.IPathDecriptor) { public async move(pathDescriptorArg: interfaces.IPathDecriptor) {
let moveToPath = ''; let moveToPath: string = '';
const isDirectory = await this.parentDirectoryRef.bucketRef.isDirectory(pathDescriptorArg); const isDirectory = await this.parentDirectoryRef.bucketRef.isDirectory(pathDescriptorArg);
if (isDirectory) { if (isDirectory) {
moveToPath = await helpers.reducePathDescriptorToPath({ moveToPath = await helpers.reducePathDescriptorToPath({
...pathDescriptorArg, ...pathDescriptorArg,
path: plugins.path.join(pathDescriptorArg.path, this.name), path: plugins.path.join(pathDescriptorArg.path!, this.name),
}); });
} else {
moveToPath = await helpers.reducePathDescriptorToPath(pathDescriptorArg);
} }
// lets move the file // lets move the file
await this.parentDirectoryRef.bucketRef.fastMove({ await this.parentDirectoryRef.bucketRef.fastMove({
sourcePath: this.getBasePath(), sourcePath: this.getBasePath(),
destinationPath: moveToPath, destinationPath: moveToPath,
overwrite: true,
}); });
// lets move the metadatafile // lets move the metadatafile
if (!this.name.endsWith('.metadata')) {
const metadata = await this.getMetaData(); const metadata = await this.getMetaData();
await metadata.metadataFile.move(pathDescriptorArg); await this.parentDirectoryRef.bucketRef.fastMove({
sourcePath: metadata.metadataFile.getBasePath(),
destinationPath: moveToPath + '.metadata',
overwrite: true,
});
}
// lets update references of this
const baseDirectory = await this.parentDirectoryRef.bucketRef.getBaseDirectory();
this.parentDirectoryRef = await baseDirectory.getSubDirectoryByNameStrict(
await helpers.reducePathDescriptorToPath(pathDescriptorArg),
{
couldBeFilePath: true,
}
);
this.name = pathDescriptorArg.path!;
}
public async hasMetaData(): Promise<boolean> {
if (!this.name.endsWith('.metadata')) {
const hasMetadataBool = MetaData.hasMetaData({
file: this,
});
return hasMetadataBool;
} else {
return false;
}
} }
/** /**
@ -230,4 +293,11 @@ export class File {
contents: JSON.stringify(dataArg), contents: JSON.stringify(dataArg),
}); });
} }
public async getMagicBytes(optionsArg: { length: number }): Promise<Buffer> {
return this.parentDirectoryRef.bucketRef.getMagicBytes({
path: this.getBasePath(),
length: optionsArg.length,
});
}
} }

View File

@ -3,14 +3,22 @@ import * as plugins from './plugins.js';
import { File } from './classes.file.js'; import { File } from './classes.file.js';
export class MetaData { export class MetaData {
public static async hasMetaData(optionsArg: { file: File }) {
// lets find the existing metadata file
const existingFile = await optionsArg.file.parentDirectoryRef.getFile({
path: optionsArg.file.name + '.metadata',
});
return !!existingFile;
}
// static // static
public static async createForFile(optionsArg: { file: File }) { public static async createForFile(optionsArg: { file: File }) {
const metaData = new MetaData(); const metaData = new MetaData();
metaData.fileRef = optionsArg.file; metaData.fileRef = optionsArg.file;
// lets find the existing metadata file // lets find the existing metadata file
metaData.metadataFile = await metaData.fileRef.parentDirectoryRef.getFile({ metaData.metadataFile = await metaData.fileRef.parentDirectoryRef.getFileStrict({
name: metaData.fileRef.name + '.metadata', path: metaData.fileRef.name + '.metadata',
createWithContents: '{}', createWithContents: '{}',
}); });
@ -21,20 +29,34 @@ export class MetaData {
/** /**
* the file that contains the metadata * the file that contains the metadata
*/ */
metadataFile: File; metadataFile!: File;
/** /**
* the file that the metadata is for * the file that the metadata is for
*/ */
fileRef: File; fileRef!: File;
public async getFileType(optionsArg?: { public async getFileType(optionsArg?: {
useFileExtension?: boolean; useFileExtension?: boolean;
useMagicBytes?: boolean; useMagicBytes?: boolean;
}): Promise<string> { }): Promise<plugins.smartmime.IFileTypeResult | undefined> {
if ((optionsArg && optionsArg.useFileExtension) || optionsArg.useFileExtension === undefined) { if ((optionsArg && optionsArg.useFileExtension) || !optionsArg) {
return plugins.path.extname(this.fileRef.name); const fileType = await plugins.smartmime.detectMimeType({
path: this.fileRef.name,
});
return fileType;
} }
if (optionsArg && optionsArg.useMagicBytes) {
const fileType = await plugins.smartmime.detectMimeType({
buffer: await this.fileRef.getMagicBytes({
length: 100,
})
});
return fileType;
}
throw new Error('optionsArg.useFileExtension and optionsArg.useMagicBytes cannot both be false');
} }
/** /**
@ -44,13 +66,13 @@ export class MetaData {
const stat = await this.fileRef.parentDirectoryRef.bucketRef.fastStat({ const stat = await this.fileRef.parentDirectoryRef.bucketRef.fastStat({
path: this.fileRef.getBasePath(), path: this.fileRef.getBasePath(),
}); });
return stat.size; return stat.ContentLength!;
} }
private prefixCustomMetaData = 'custom_'; private prefixCustomMetaData = 'custom_';
public async storeCustomMetaData<T = any>(optionsArg: { key: string; value: T }) { public async storeCustomMetaData<T = any>(optionsArg: { key: string; value: T }) {
const data = await this.metadataFile.getContentsAsString(); const data = await this.metadataFile.getJsonData();
data[this.prefixCustomMetaData + optionsArg.key] = optionsArg.value; data[this.prefixCustomMetaData + optionsArg.key] = optionsArg.value;
await this.metadataFile.writeJsonData(data); await this.metadataFile.writeJsonData(data);
} }

View File

@ -1,22 +1,34 @@
// classes.smartbucket.ts
import * as plugins from './plugins.js'; import * as plugins from './plugins.js';
import { Bucket } from './classes.bucket.js'; import { Bucket } from './classes.bucket.js';
export class SmartBucket { export class SmartBucket {
public config: plugins.tsclass.storage.IS3Descriptor; public config: plugins.tsclass.storage.IS3Descriptor;
public minioClient: plugins.minio.Client; public s3Client: plugins.s3.S3Client;
/**
* the constructor of SmartBucket
*/
/** /**
* the constructor of SmartBucket * the constructor of SmartBucket
*/ */
constructor(configArg: plugins.tsclass.storage.IS3Descriptor) { constructor(configArg: plugins.tsclass.storage.IS3Descriptor) {
this.config = configArg; this.config = configArg;
this.minioClient = new plugins.minio.Client({
endPoint: this.config.endpoint, const protocol = configArg.useSsl === false ? 'http' : 'https';
port: configArg.port || 443, const port = configArg.port ? `:${configArg.port}` : '';
useSSL: configArg.useSsl !== undefined ? configArg.useSsl : true, const endpoint = `${protocol}://${configArg.endpoint}${port}`;
accessKey: this.config.accessKey,
secretKey: this.config.accessSecret, this.s3Client = new plugins.s3.S3Client({
endpoint,
region: configArg.region || 'us-east-1',
credentials: {
accessKeyId: configArg.accessKey,
secretAccessKey: configArg.accessSecret,
},
forcePathStyle: true, // Necessary for S3-compatible storage like MinIO or Wasabi
}); });
} }
@ -29,7 +41,15 @@ export class SmartBucket {
await Bucket.removeBucketByName(this, bucketName); await Bucket.removeBucketByName(this, bucketName);
} }
public async getBucketByName(bucketName: string) { public async getBucketByName(bucketNameArg: string) {
return Bucket.getBucketByName(this, bucketName); return Bucket.getBucketByName(this, bucketNameArg);
}
public async getBucketByNameStrict(...args: Parameters<SmartBucket['getBucketByName']>) {
const bucket = await this.getBucketByName(...args);
if (!bucket) {
throw new Error(`Bucket ${args[0]} does not exist.`);
}
return bucket;
} }
} }

30
ts/classes.trash.ts Normal file
View File

@ -0,0 +1,30 @@
import * as plugins from './plugins.js';
import * as interfaces from './interfaces.js';
import * as helpers from './helpers.js';
import type { Bucket } from './classes.bucket.js';
import type { Directory } from './classes.directory.js';
import type { File } from './classes.file.js';
export class Trash {
public bucketRef: Bucket;
constructor(bucketRefArg: Bucket) {
this.bucketRef = bucketRefArg;
}
public async getTrashDir() {
return this.bucketRef.getDirectoryFromPath({ path: '.trash' });
}
public async getTrashedFileByOriginalName(pathDescriptor: interfaces.IPathDecriptor): Promise<File> {
const trashDir = await this.getTrashDir();
const originalPath = await helpers.reducePathDescriptorToPath(pathDescriptor);
const trashKey = await this.getTrashKeyByOriginalBasePath(originalPath);
return trashDir.getFileStrict({ path: trashKey });
}
public async getTrashKeyByOriginalBasePath (originalPath: string): Promise<string> {
return plugins.smartstring.base64.encode(originalPath);
}
}

View File

@ -1,3 +1,5 @@
// plugins.ts
// node native // node native
import * as path from 'path'; import * as path from 'path';
import * as stream from 'stream'; import * as stream from 'stream';
@ -10,9 +12,10 @@ import * as smartpath from '@push.rocks/smartpath';
import * as smartpromise from '@push.rocks/smartpromise'; import * as smartpromise from '@push.rocks/smartpromise';
import * as smartrx from '@push.rocks/smartrx'; import * as smartrx from '@push.rocks/smartrx';
import * as smartstream from '@push.rocks/smartstream'; import * as smartstream from '@push.rocks/smartstream';
import * as smartstring from '@push.rocks/smartstring';
import * as smartunique from '@push.rocks/smartunique'; import * as smartunique from '@push.rocks/smartunique';
export { smartmime, smartpath, smartpromise, smartrx, smartstream, smartunique }; export { smartmime, smartpath, smartpromise, smartrx, smartstream, smartstring, smartunique };
// @tsclass // @tsclass
import * as tsclass from '@tsclass/tsclass'; import * as tsclass from '@tsclass/tsclass';
@ -22,6 +25,8 @@ export {
} }
// third party scope // third party scope
import * as minio from 'minio'; import * as s3 from '@aws-sdk/client-s3';
export { minio }; export {
s3,
}

View File

@ -6,7 +6,8 @@
"module": "NodeNext", "module": "NodeNext",
"moduleResolution": "NodeNext", "moduleResolution": "NodeNext",
"esModuleInterop": true, "esModuleInterop": true,
"verbatimModuleSyntax": true "verbatimModuleSyntax": true,
"strict": true
}, },
"exclude": [ "exclude": [
"dist_*/**/*.d.ts" "dist_*/**/*.d.ts"