2.0.5

npmextra.json

@@ -5,12 +5,29 @@
   "gitzone": {
     "projectType": "npm",
     "module": {
-      "githost": "gitlab.com",
+      "githost": "code.foss.global",
       "gitscope": "push.rocks",
       "gitrepo": "smartbucket",
-      "description": "simple cloud independent object storage",
+      "description": "A TypeScript library for simple cloud independent object storage with support for buckets, directories, and files.",
       "npmPackagename": "@push.rocks/smartbucket",
-      "license": "MIT"
+      "license": "MIT",
+      "keywords": [
+        "cloud storage",
+        "object storage",
+        "minio",
+        "S3",
+        "TypeScript",
+        "smartstream",
+        "smartpromise",
+        "smartpath",
+        "smartrx",
+        "buckets",
+        "files management",
+        "directories management"
+      ]
     }
+  },
+  "tsdoc": {
+    "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
   }
 }

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@push.rocks/smartbucket",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@push.rocks/smartbucket",
-      "version": "2.0.3",
+      "version": "2.0.5",
       "license": "UNLICENSED",
       "dependencies": {
         "@push.rocks/smartpath": "^5.0.5",

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@push.rocks/smartbucket",
-  "version": "2.0.3",
+  "version": "2.0.5",
-  "description": "simple cloud independent object storage",
+  "description": "A TypeScript library for simple cloud independent object storage with support for buckets, directories, and files.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "type": "module",
@@ -12,8 +12,8 @@
     "build": "(tsbuild --web --allowimplicitany)"
   },
   "devDependencies": {
-    "@git.zone/tsrun": "^1.2.46",
     "@git.zone/tsbuild": "^2.1.63",
+    "@git.zone/tsrun": "^1.2.46",
     "@git.zone/tstest": "^1.0.71",
     "@push.rocks/qenv": "^6.0.4",
     "@push.rocks/tapbundle": "^5.0.3"
@@ -23,6 +23,7 @@
     "@push.rocks/smartpromise": "^4.0.3",
     "@push.rocks/smartrx": "^3.0.7",
     "@push.rocks/smartstream": "^2.0.2",
+    "@tsclass/tsclass": "^4.0.50",
     "@types/minio": "^7.0.13",
     "minio": "^7.0.28"
   },
@@ -41,5 +42,19 @@
   ],
   "browserslist": [
     "last 1 chrome versions"
+  ],
+  "keywords": [
+    "cloud storage",
+    "object storage",
+    "minio",
+    "S3",
+    "TypeScript",
+    "smartstream",
+    "smartpromise",
+    "smartpath",
+    "smartrx",
+    "buckets",
+    "files management",
+    "directories management"
   ]
 }

pnpm-lock.yaml

@@ -17,6 +17,9 @@ dependencies:
   '@push.rocks/smartstream':
     specifier: ^2.0.2
     version: 2.0.8
+  '@tsclass/tsclass':
+    specifier: ^4.0.50
+    version: 4.0.50
   '@types/minio':
     specifier: ^7.0.13
     version: 7.0.13
@@ -82,7 +85,7 @@ packages:
       '@push.rocks/smartsitemap': 2.0.3
       '@push.rocks/smarttime': 4.0.6
       '@push.rocks/webstore': 2.0.13
-      '@tsclass/tsclass': 4.0.46
+      '@tsclass/tsclass': 4.0.50
       '@types/express': 4.17.20
       body-parser: 1.20.2
       cors: 2.8.5
@@ -816,7 +819,7 @@ packages:
       '@push.rocks/smartpromise': 4.0.3
       '@push.rocks/smartpuppeteer': 2.0.2
       '@push.rocks/smartunique': 3.0.6
-      '@tsclass/tsclass': 4.0.42
+      '@tsclass/tsclass': 4.0.50
       '@types/express': 4.17.17
       express: 4.18.2
       pdf-merger-js: 3.4.0
@@ -881,7 +884,7 @@ packages:
       '@push.rocks/smartxml': 1.0.8
       '@push.rocks/smartyaml': 2.0.5
       '@push.rocks/webrequest': 3.0.34
-      '@tsclass/tsclass': 4.0.46
+      '@tsclass/tsclass': 4.0.50
     dev: true
 
   /@push.rocks/smartsocket@2.0.24:
@@ -1324,17 +1327,10 @@ packages:
       type-fest: 2.19.0
     dev: true
 
-  /@tsclass/tsclass@4.0.42:
+  /@tsclass/tsclass@4.0.50:
-    resolution: {integrity: sha512-mWZ8k3G7VL/dSNaJCv7mjbad6movf2rTE+1MdsXMoCxblZpJ3YzqlRsKm/JUQkxqF1H28q6m/L5BV42LfNZsiA==}
+    resolution: {integrity: sha512-ICUe4hfebpvbn8JkReGP1m3DCTq6S5FIhLJzbFx9F7tx6dn909fA9YIEHkFeMj2X7fT5aGvAXOZRlT52GsnSUw==}
     dependencies:
-      type-fest: 3.13.0
+      type-fest: 4.10.2
-    dev: true
-
-  /@tsclass/tsclass@4.0.46:
-    resolution: {integrity: sha512-UovPUvlozv1ftJp4KW5tt4MP/LQCNP3lSCinjyIrLkopOymczyzONUGvSAAwOBf1XBE9bO0tI4KtRuXWN9XBXQ==}
-    dependencies:
-      type-fest: 4.6.0
-    dev: true
 
   /@tsconfig/node10@1.0.9:
     resolution: {integrity: sha512-jNsYVVxU8v5g43Erja32laIDHXeoNvFEpX33OK4d6hljo3jDhCBDhx5dhCCTMWUojscpAagGiRkBKxpdl9fxqA==}
@@ -5654,15 +5650,9 @@ packages:
     engines: {node: '>=12.20'}
     dev: true
 
-  /type-fest@3.13.0:
+  /type-fest@4.10.2:
-    resolution: {integrity: sha512-Gur3yQGM9qiLNs0KPP7LPgeRbio2QTt4xXouobMCarR0/wyW3F+F/+OWwshg3NG0Adon7uQfSZBpB46NfhoF1A==}
+    resolution: {integrity: sha512-anpAG63wSpdEbLwOqH8L84urkL6PiVIov3EMmgIhhThevh9aiMQov+6Btx0wldNcvm4wV+e2/Rt1QdDwKHFbHw==}
-    engines: {node: '>=14.16'}
-    dev: true
-
-  /type-fest@4.6.0:
-    resolution: {integrity: sha512-rLjWJzQFOq4xw7MgJrCZ6T1jIOvvYElXT12r+y0CC6u67hegDHaxcPqb2fZHOGlqxugGQPNB1EnTezjBetkwkw==}
     engines: {node: '>=16'}
-    dev: true
 
   /type-is@1.6.18:
     resolution: {integrity: sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==}

readme.hints.md

@@ -0,0 +1 @@
+ 

readme.md

@@ -1,39 +1,155 @@
 # @push.rocks/smartbucket
 simple cloud independent object storage
 
-## Availabililty and Links
+## Install
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartbucket)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartbucket)
-* [github.com (source mirror)](https://github.com/pushrocks/smartbucket)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartbucket/)
 
-## Status for master
+To install `@push.rocks/smartbucket`, you need to have Node.js and npm (Node Package Manager) installed on your system. If you have them installed, you can add `@push.rocks/smartbucket` to your project by running the following command in your project's root directory:
 
-Status Category | Status Badge
+```bash
--- | --
+npm install @push.rocks/smartbucket --save
-GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartbucket/badges/master/pipeline.svg)](https://lossless.cloud)
+```
-GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartbucket/badges/master/coverage.svg)](https://lossless.cloud)
+
-npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartbucket)](https://lossless.cloud)
+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.
-Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartbucket)](https://lossless.cloud)
-TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
-node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
-PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/smartbucket)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartbucket)](https://lossless.cloud)
-BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartbucket)](https://lossless.cloud)
-Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 
-Use TypeScript for best in class intellisense.
+`@push.rocks/smartbucket` is a 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.
 
-## Contribution
+To use `@push.rocks/smartbucket` in your project, you'll need to follow these general steps:
 
-We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+### Setting Up
 
-For further information read the linked docs at the top of this readme.
+First, ensure you are using ECMAScript modules (ESM) and TypeScript in your project for best compatibility. 
 
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+Here's how to import and initialize smartbucket in a TypeScript file:
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
+```typescript
+import {
+  SmartBucket,
+  Bucket,
+  Directory,
+  File
+} from '@push.rocks/smartbucket';
+
+const mySmartBucket = new SmartBucket({
+  accessKey: "yourAccessKey",
+  accessSecret: "yourSecretKey",
+  endpoint: "yourEndpointURL",
+});
+```
+
+Make sure to replace `"yourAccessKey"`, `"yourSecretKey"`, and `"yourEndpointURL"` with your actual credentials and endpoint URL.
+
+### Creating a New Bucket
+
+To create a new bucket:
+
+```typescript
+async function createBucket(bucketName: string) {
+  try {
+    const myBucket: Bucket = await mySmartBucket.createBucket(bucketName);
+    console.log(`Bucket ${bucketName} created successfully.`);
+  } catch (error) {
+    console.error("Error creating bucket:", error);
+  }
+}
+
+// Use the function
+createBucket("exampleBucket");
+```
+
+**Important:** Bucket names must be unique across the storage service.
+
+### Listing Buckets
+
+To list all buckets:
+
+```typescript
+// 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.
+```
+
+### Uploading Objects to a Bucket
+
+To upload an object to a bucket:
+
+```typescript
+async function uploadFile(bucketName: string, filePath: string, fileContent: Buffer | string) {
+  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  if (myBucket) {
+    await myBucket.fastStore(filePath, fileContent);
+    console.log(`File uploaded to ${bucketName} at ${filePath}`);
+  }
+}
+
+// Use the function
+uploadFile("exampleBucket", "path/to/object.txt", "Hello, world!");
+```
+
+### Downloading Objects from a Bucket
+
+To download an object:
+
+```typescript
+async function downloadFile(bucketName: string, filePath: string) {
+  const myBucket: Bucket = await mySmartBucket.getBucketByName(bucketName);
+  if (myBucket) {
+    const fileContent: Buffer = await myBucket.fastGet(filePath);
+    console.log("Downloaded file content:", fileContent.toString());
+  }
+}
+
+// Use the function
+downloadFile("exampleBucket", "path/to/object.txt");
+```
+
+### Deleting Objects
+
+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(filePath);
+    console.log(`File at ${filePath} deleted from ${bucketName}.`);
+  }
+}
+
+// Use the function
+deleteFile("exampleBucket", "path/to/object.txt");
+```
+
+### Working with Directories
+
+`@push.rocks/smartbucket` abstracts directories within buckets for easier object management. You can create, list, and delete directories using the `Directory` class.
+
+### Additional Features
+
+- **Bucket Policies:** Manage bucket policies to control access permissions.
+- **Object Metadata:** Retrieve and modify object metadata.
+- **Cloud-Agnostic:** Designed to work with multiple cloud providers, allowing for easier migration or multi-cloud strategies.
+
+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.
+
+> **Note:** This document focuses on basic operations to get you started with `@push.rocks/smartbucket`. For advanced usage, including streaming data, managing bucket policies, and handling large file uploads, refer to the detailed API documentation and examples.
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

test/test.ts

@@ -33,7 +33,7 @@ tap.test('should get a bucket', async () => {
 
 // Fast operations
 tap.test('should store data in bucket fast', async () => {
-  await myBucket.fastStore('hithere/socool.txt', 'hi there!');
+  await myBucket.fastPut('hithere/socool.txt', 'hi there!');
 });
 
 tap.test('should get data in bucket', async () => {
@@ -49,12 +49,12 @@ tap.test('should delete data in bucket', async () => {
 // fs operations
 
 tap.test('prepare for directory style tests', async () => {
-  await myBucket.fastStore('dir1/file1.txt', 'dir1/file1.txt content');
+  await myBucket.fastPut('dir1/file1.txt', 'dir1/file1.txt content');
-  await myBucket.fastStore('dir1/file2.txt', 'dir1/file2.txt content');
+  await myBucket.fastPut('dir1/file2.txt', 'dir1/file2.txt content');
-  await myBucket.fastStore('dir2/file1.txt', 'dir2/file1.txt content');
+  await myBucket.fastPut('dir2/file1.txt', 'dir2/file1.txt content');
-  await myBucket.fastStore('dir3/file1.txt', 'dir3/file1.txt content');
+  await myBucket.fastPut('dir3/file1.txt', 'dir3/file1.txt content');
-  await myBucket.fastStore('dir3/dir4/file1.txt', 'dir3/dir4/file1.txt content');
+  await myBucket.fastPut('dir3/dir4/file1.txt', 'dir3/dir4/file1.txt content');
-  await myBucket.fastStore('file1.txt', 'file1 content');
+  await myBucket.fastPut('file1.txt', 'file1 content');
 });
 
 tap.test('should get base directory', async () => {

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartbucket',
-  version: '2.0.3',
+  version: '2.0.5',
-  description: 'simple cloud independent object storage'
+  description: 'A TypeScript library for simple cloud independent object storage with support for buckets, directories, and files.'
 }

ts/smartbucket.classes.bucket.ts

@@ -49,7 +49,7 @@ export class Bucket {
   /**
    * store file
    */
-  public async fastStore(pathArg: string, fileContent: string | Buffer): Promise<void> {
+  public async fastPut(pathArg: string, fileContent: string | Buffer): Promise<void> {
     const streamIntake = new plugins.smartstream.StreamIntake();
     const putPromise = this.smartbucketRef.minioClient
       .putObject(this.name, pathArg, streamIntake.getReadable())
@@ -115,6 +115,59 @@ export class Bucket {
     return replaySubject;
   }
 
+  /**
+   * store file as stream
+   */
+  public async fastPutStream(optionsArg: {
+    pathArg: string;
+    dataStream: plugins.stream.Readable;
+    metadata?: { [key: string]: string };
+  }): Promise<void> {
+    await this.smartbucketRef.minioClient.putObject(
+      this.name,
+      optionsArg.pathArg,
+      optionsArg.dataStream,
+      null,
+      ...(optionsArg.metadata
+        ? (() => {
+            const returnObject: any = {};
+            return returnObject;
+          })()
+        : {})
+    );
+  }
+
+  public async updateMetadata(
+    bucket: string,
+    objectKey: string,
+    metadata: { [key: string]: string }
+  ): Promise<void> {
+    try {
+      // Retrieve current object information to use in copy conditions
+      const currentObjInfo = await this.smartbucketRef.minioClient.statObject(bucket, objectKey);
+  
+      // Setting up copy conditions
+      const copyConditions = new plugins.minio.CopyConditions();
+  
+      // Prepare new metadata, merging current and new metadata
+      const newMetadata = {
+        ...currentObjInfo.metaData,
+        ...metadata,
+      };
+  
+      // Define the copy operation as a Promise
+      await this.smartbucketRef.minioClient.copyObject(
+        bucket,
+        objectKey,
+        `/${bucket}/${objectKey}`,
+        copyConditions,
+      );
+    } catch (err) {
+      console.error('Error updating metadata:', err);
+      throw err; // rethrow to allow caller to handle
+    }
+  }
+
   /**
    * removeObject
    */

ts/smartbucket.classes.directory.ts

@@ -183,7 +183,7 @@ export class Directory {
   // file operations
   public async fastStore(pathArg: string, contentArg: string | Buffer) {
     const path = plugins.path.join(this.getBasePath(), pathArg);
-    await this.bucketRef.fastStore(path, contentArg);
+    await this.bucketRef.fastPut(path, contentArg);
   }
 
   public async fastGet(pathArg: string) {

ts/smartbucket.classes.smartbucket.ts

@@ -1,23 +1,15 @@
 import * as plugins from './smartbucket.plugins.js';
 import { Bucket } from './smartbucket.classes.bucket.js';
 
-export interface ISmartBucketConfig {
-  endpoint: string;
-  port?: number;
-  useSsl?: boolean;
-  accessKey: string;
-  accessSecret: string;
-}
-
 export class SmartBucket {
-  public config: ISmartBucketConfig;
+  public config: plugins.tsclass.storage.IS3Descriptor;
 
   public minioClient: plugins.minio.Client;
 
   /**
    * the constructor of SmartBucket
    */
-  constructor(configArg: ISmartBucketConfig) {
+  constructor(configArg: plugins.tsclass.storage.IS3Descriptor) {
     this.config = configArg;
     this.minioClient = new plugins.minio.Client({
       endPoint: this.config.endpoint,

ts/smartbucket.plugins.ts

@@ -1,8 +1,10 @@
 // node native
 import * as path from 'path';
+import * as stream from 'stream';
 
-export { path };
+export { path, stream };
 
+// @push.rocks scope
 import * as smartpath from '@push.rocks/smartpath';
 import * as smartpromise from '@push.rocks/smartpromise';
 import * as smartrx from '@push.rocks/smartrx';
@@ -10,6 +12,13 @@ import * as smartstream from '@push.rocks/smartstream';
 
 export { smartpath, smartpromise, smartrx, smartstream };
 
+// @tsclass
+import * as tsclass from '@tsclass/tsclass';
+
+export {
+  tsclass,
+}
+
 // third party scope
 import * as minio from 'minio';